From cd0be72c391ac42d2b32bf3eb250d1b4de2f76f5 Mon Sep 17 00:00:00 2001 From: gnongsie Date: Thu, 23 May 2024 19:50:51 +0530 Subject: [PATCH 01/17] Added new cache solution --- .../ApiClient.mustache | 2 +- .../cybersource-php-template/api.mustache | 2 +- .../configuration.mustache | 2 +- lib/ApiClient.php | 2 +- lib/Authentication/Core/Authentication.php | 2 +- .../Core/MerchantConfiguration.php | 4 +- .../Jwt/JsonWebTokenGenerator.php | 2 +- lib/Authentication/Jwt/JsonWebTokenHeader.php | 19 +++++--- .../PayloadDigest/PayloadDigest.php | 2 +- lib/Authentication/Util/Cache.php | 47 +++++++++++++++++++ lib/Authentication/Util/JWE/JWEUtility.php | 12 +++-- lib/Configuration.php | 2 +- 12 files changed, 78 insertions(+), 20 deletions(-) create mode 100644 lib/Authentication/Util/Cache.php diff --git a/generator/cybersource-php-template/ApiClient.mustache b/generator/cybersource-php-template/ApiClient.mustache index 5c35bebb1..ed2602574 100644 --- a/generator/cybersource-php-template/ApiClient.mustache +++ b/generator/cybersource-php-template/ApiClient.mustache @@ -108,7 +108,7 @@ class ApiClient $this->clientId = $this->getClientId(); if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $merchantConfig->getLogConfiguration()); } } diff --git a/generator/cybersource-php-template/api.mustache b/generator/cybersource-php-template/api.mustache index 9a5002b7e..b9d21a87c 100644 --- a/generator/cybersource-php-template/api.mustache +++ b/generator/cybersource-php-template/api.mustache @@ -57,7 +57,7 @@ use \{{invokerPackage}}\Logging\LogFactory as LogFactory; $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/generator/cybersource-php-template/configuration.mustache b/generator/cybersource-php-template/configuration.mustache index 0bde0cac8..97ac55e0a 100644 --- a/generator/cybersource-php-template/configuration.mustache +++ b/generator/cybersource-php-template/configuration.mustache @@ -178,7 +178,7 @@ class Configuration { $this->logConfig = new LogConfiguration(); if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $this->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $this->getLogConfiguration()); } } diff --git a/lib/ApiClient.php b/lib/ApiClient.php index eb53e4a75..20d18b82f 100755 --- a/lib/ApiClient.php +++ b/lib/ApiClient.php @@ -118,7 +118,7 @@ public function __construct(\CyberSource\Configuration $config = null, \CyberSou $this->clientId = $this->getClientId(); if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $merchantConfig->getLogConfiguration()); } } diff --git a/lib/Authentication/Core/Authentication.php b/lib/Authentication/Core/Authentication.php index 303c063f3..077cb4dae 100644 --- a/lib/Authentication/Core/Authentication.php +++ b/lib/Authentication/Core/Authentication.php @@ -20,7 +20,7 @@ public function __construct(\CyberSource\Logging\LogConfiguration $logConfig = n { if (null !== $logConfig) { if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $logConfig); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $logConfig); } } } diff --git a/lib/Authentication/Core/MerchantConfiguration.php b/lib/Authentication/Core/MerchantConfiguration.php index 753413f2e..30d0d4eea 100644 --- a/lib/Authentication/Core/MerchantConfiguration.php +++ b/lib/Authentication/Core/MerchantConfiguration.php @@ -236,7 +236,7 @@ public function __construct() $this->logConfig = new LogConfiguration(); if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $this->logConfig); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $this->logConfig); } } @@ -1146,7 +1146,7 @@ public function validateMerchantData() } } - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $this->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $this->getLogConfiguration()); self::$logger->info(GlobalParameter::LOG_START_MSG); $logConfig = $this->getLogConfiguration(); $configurationData = array( diff --git a/lib/Authentication/Jwt/JsonWebTokenGenerator.php b/lib/Authentication/Jwt/JsonWebTokenGenerator.php index 74426fdc0..13c8e6536 100644 --- a/lib/Authentication/Jwt/JsonWebTokenGenerator.php +++ b/lib/Authentication/Jwt/JsonWebTokenGenerator.php @@ -21,7 +21,7 @@ class JsonWebTokenGenerator implements TokenGenerator public function __construct(\CyberSource\Logging\LogConfiguration $logConfig) { if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $logConfig); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $logConfig); } } diff --git a/lib/Authentication/Jwt/JsonWebTokenHeader.php b/lib/Authentication/Jwt/JsonWebTokenHeader.php index 31367de8f..f2015bbee 100644 --- a/lib/Authentication/Jwt/JsonWebTokenHeader.php +++ b/lib/Authentication/Jwt/JsonWebTokenHeader.php @@ -8,12 +8,14 @@ use CyberSource\Authentication\Core\AuthException as AuthException; use Firebase\JWT\JWT as JWT; use CyberSource\Logging\LogFactory as LogFactory; +use CyberSource\Authentication\Util\Cache as Cache; require_once 'vendor/autoload.php'; class JsonWebTokenHeader { private static $logger = null; + private static $cache = null; /** * Constructor @@ -21,8 +23,10 @@ class JsonWebTokenHeader public function __construct(\CyberSource\Logging\LogConfiguration $logConfig) { if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $logConfig); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $logConfig); } + + self::$cache = new Cache(); } //Get the JasonWeb Token @@ -71,12 +75,13 @@ public function getJsonWebToken($jwtBody, $merchantConfig) throw $exception; } - if(!empty($cacheKey)) - $cache_cert_store = apcu_fetch($cacheKey); - if($cache_cert_store ==false ){ - $cache_cert_store=""; - $result = apcu_store("$cacheKey", $cert_store); - $cache_cert_store = apcu_fetch($cacheKey); + if(!empty($cacheKey)) { + $cache_cert_store = self::$cache->fetchFromCache($cacheKey); // apcu_fetch($cacheKey); + } + if($cache_cert_store == false){ + $cache_cert_store = ""; + $result = self::$cache->storeInCache("$cacheKey", $cert_store); //apcu_store("$cacheKey", $cert_store); + $cache_cert_store = self::$cache->fetchFromCache($cacheKey); // apcu_fetch($cacheKey); } //read the certificate from cert obj if (openssl_pkcs12_read($cache_cert_store, $cert_info, $keyPass)) diff --git a/lib/Authentication/PayloadDigest/PayloadDigest.php b/lib/Authentication/PayloadDigest/PayloadDigest.php index 28d519fa2..9263080ee 100644 --- a/lib/Authentication/PayloadDigest/PayloadDigest.php +++ b/lib/Authentication/PayloadDigest/PayloadDigest.php @@ -18,7 +18,7 @@ class PayloadDigest public function __construct(\CyberSource\Logging\LogConfiguration $logConfig = null) { if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $logConfig); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $logConfig); } } diff --git a/lib/Authentication/Util/Cache.php b/lib/Authentication/Util/Cache.php new file mode 100644 index 000000000..7d4b097d2 --- /dev/null +++ b/lib/Authentication/Util/Cache.php @@ -0,0 +1,47 @@ +checkIfExistInCache($key)) + { + return $this->file_cache[$key]; + } + + return false; + } + + public function storeInCache($key, $value) + { + if (!$this->checkIfExistInCache($key)) + { + $this->file_cache[$key] = $value; + return true; + } + + return false; + } + + public function checkIfExistInCache($key) + { + foreach ($this->file_cache as $cache_key => $cache_value) + { + if (isset($cache_value)) + { + return true; + } + } + + return false; + } +} \ No newline at end of file diff --git a/lib/Authentication/Util/JWE/JWEUtility.php b/lib/Authentication/Util/JWE/JWEUtility.php index d2fddd09d..24010b777 100644 --- a/lib/Authentication/Util/JWE/JWEUtility.php +++ b/lib/Authentication/Util/JWE/JWEUtility.php @@ -14,9 +14,12 @@ use Jose\Component\Encryption\Serializer\CompactSerializer; use Jose\Component\Encryption\Serializer\JWESerializerManager; use Jose\Component\KeyManagement\JWKFactory; +use CyberSource\Authentication\Util\Cache as Cache; class JWEUtility { + private static $cache = null; + private static function loadKeyFromPEMFile($path) { return JWKFactory::createFromKeyFile( $path, @@ -28,17 +31,20 @@ private static function loadKeyFromPEMFile($path) { } public static function decryptJWEUsingPEM(MerchantConfiguration $merchantConfig, string $jweBase64Data) { + if (!isset(self::$cache)) { + self::$cache = new Cache(); + } $filePath = $merchantConfig -> getJwePEMFileDirectory(); if (!file_exists($filePath)) { return null; } $cacheKey = 'privateKeyFromPEMFile' . '_' . strtotime(date("F d Y H:i:s", filemtime($filePath))); - $cached_key = apcu_exists($cacheKey); + $cached_key = self::$cache->checkIfExistInCache($cacheKey); // apcu_exists($cacheKey); if (!$cached_key) { $privateKeyFromPEMFile = self::loadKeyFromPEMFile($merchantConfig->getJwePEMFileDirectory()); - apcu_store($cacheKey, $privateKeyFromPEMFile); + self::$cache->storeInCache($cacheKey, $privateKeyFromPEMFile); // apcu_store($cacheKey, $privateKeyFromPEMFile); } - $jweKey = apcu_fetch($cacheKey); + $jweKey = self::$cache->fetchFromCache($cacheKey); // apcu_fetch($cacheKey); $serializerManager = new JWESerializerManager([ new CompactSerializer(), ]); diff --git a/lib/Configuration.php b/lib/Configuration.php index c66f4a3c0..9ecd244ab 100644 --- a/lib/Configuration.php +++ b/lib/Configuration.php @@ -187,7 +187,7 @@ public function __construct() { $this->logConfig = new LogConfiguration(); if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $this->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $this->getLogConfiguration()); } } From 397a0ea2be92c4253a96b7b1af934006488a9b85 Mon Sep 17 00:00:00 2001 From: gnongsie Date: Fri, 24 May 2024 11:04:09 +0530 Subject: [PATCH 02/17] Merged with June 2024 Release --- lib/Api/AsymmetricKeyManagementApi.php | 2 +- lib/Api/BatchesApi.php | 2 +- lib/Api/BillingAgreementsApi.php | 2 +- lib/Api/CaptureApi.php | 2 +- lib/Api/ChargebackDetailsApi.php | 2 +- lib/Api/ChargebackSummariesApi.php | 2 +- lib/Api/ConversionDetailsApi.php | 2 +- lib/Api/CreateNewWebhooksApi.php | 2 +- lib/Api/CreditApi.php | 2 +- lib/Api/CustomerApi.php | 2 +- lib/Api/CustomerPaymentInstrumentApi.php | 2 +- lib/Api/CustomerShippingAddressApi.php | 2 +- lib/Api/DecisionManagerApi.php | 2 +- lib/Api/DownloadDTDApi.php | 2 +- lib/Api/DownloadXSDApi.php | 2 +- lib/Api/EMVTagDetailsApi.php | 2 +- lib/Api/InstrumentIdentifierApi.php | 2 +- .../InterchangeClearingLevelDetailsApi.php | 2 +- lib/Api/InvoiceSettingsApi.php | 2 +- lib/Api/InvoicesApi.php | 2 +- lib/Api/KeymanagementApi.php | 2 +- lib/Api/KeymanagementpasswordApi.php | 2 +- lib/Api/KeymanagementpgpApi.php | 2 +- lib/Api/KeymanagementscmpApi.php | 2 +- lib/Api/ManageWebhooksApi.php | 2 +- lib/Api/MerchantBoardingApi.php | 2 +- lib/Api/MicroformIntegrationApi.php | 2 +- lib/Api/NetFundingsApi.php | 2 +- lib/Api/NotificationOfChangesApi.php | 2 +- lib/Api/PayerAuthenticationApi.php | 2 +- lib/Api/PaymentBatchSummariesApi.php | 2 +- lib/Api/PaymentInstrumentApi.php | 2 +- lib/Api/PaymentsApi.php | 2 +- lib/Api/PayoutsApi.php | 2 +- lib/Api/PlansApi.php | 2 +- lib/Api/PurchaseAndRefundDetailsApi.php | 2 +- lib/Api/PushFundsApi.php | 2 +- lib/Api/RefundApi.php | 2 +- lib/Api/ReplayWebhooksApi.php | 2 +- lib/Api/ReportDefinitionsApi.php | 2 +- lib/Api/ReportDownloadsApi.php | 2 +- lib/Api/ReportSubscriptionsApi.php | 2 +- lib/Api/ReportsApi.php | 2 +- lib/Api/RetrievalDetailsApi.php | 2 +- lib/Api/RetrievalSummariesApi.php | 2 +- lib/Api/ReversalApi.php | 2 +- lib/Api/SearchTransactionsApi.php | 2 +- lib/Api/SecureFileShareApi.php | 2 +- lib/Api/SubscriptionsApi.php | 2 +- lib/Api/SymmetricKeyManagementApi.php | 2 +- lib/Api/TaxesApi.php | 2 +- lib/Api/TokenApi.php | 2 +- lib/Api/TransactionBatchesApi.php | 2 +- lib/Api/TransactionDetailsApi.php | 2 +- lib/Api/TransientTokenDataApi.php | 2 +- lib/Api/UnifiedCheckoutCaptureContextApi.php | 2 +- lib/Api/UserManagementApi.php | 2 +- lib/Api/UserManagementSearchApi.php | 2 +- lib/Api/VerificationApi.php | 2 +- lib/Api/VoidApi.php | 2 +- ...nizationInformationBusinessInformation.php | 36 ++++++------- ...nInformationBusinessInformationAddress.php | 36 ++++++------- ...tionBusinessInformationBusinessContact.php | 54 +++++++++---------- 63 files changed, 123 insertions(+), 123 deletions(-) diff --git a/lib/Api/AsymmetricKeyManagementApi.php b/lib/Api/AsymmetricKeyManagementApi.php index ac7948c55..50f6899da 100644 --- a/lib/Api/AsymmetricKeyManagementApi.php +++ b/lib/Api/AsymmetricKeyManagementApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/BatchesApi.php b/lib/Api/BatchesApi.php index a56182bb4..c0c351251 100644 --- a/lib/Api/BatchesApi.php +++ b/lib/Api/BatchesApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/BillingAgreementsApi.php b/lib/Api/BillingAgreementsApi.php index aee1e98f1..2c8dc51b0 100644 --- a/lib/Api/BillingAgreementsApi.php +++ b/lib/Api/BillingAgreementsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/CaptureApi.php b/lib/Api/CaptureApi.php index 8552e6652..4d858996c 100644 --- a/lib/Api/CaptureApi.php +++ b/lib/Api/CaptureApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ChargebackDetailsApi.php b/lib/Api/ChargebackDetailsApi.php index 53ac47c1f..9358ce7cb 100644 --- a/lib/Api/ChargebackDetailsApi.php +++ b/lib/Api/ChargebackDetailsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ChargebackSummariesApi.php b/lib/Api/ChargebackSummariesApi.php index 5e327a29a..5460a3a6d 100644 --- a/lib/Api/ChargebackSummariesApi.php +++ b/lib/Api/ChargebackSummariesApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ConversionDetailsApi.php b/lib/Api/ConversionDetailsApi.php index 94c5c500e..9f204ea92 100644 --- a/lib/Api/ConversionDetailsApi.php +++ b/lib/Api/ConversionDetailsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/CreateNewWebhooksApi.php b/lib/Api/CreateNewWebhooksApi.php index 5744af857..6417a6d24 100644 --- a/lib/Api/CreateNewWebhooksApi.php +++ b/lib/Api/CreateNewWebhooksApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/CreditApi.php b/lib/Api/CreditApi.php index 2cfe3cc2e..8b8a5bd8b 100644 --- a/lib/Api/CreditApi.php +++ b/lib/Api/CreditApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/CustomerApi.php b/lib/Api/CustomerApi.php index e65c31998..296245623 100644 --- a/lib/Api/CustomerApi.php +++ b/lib/Api/CustomerApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/CustomerPaymentInstrumentApi.php b/lib/Api/CustomerPaymentInstrumentApi.php index fc09fa1fa..bbe45adc3 100644 --- a/lib/Api/CustomerPaymentInstrumentApi.php +++ b/lib/Api/CustomerPaymentInstrumentApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/CustomerShippingAddressApi.php b/lib/Api/CustomerShippingAddressApi.php index 9422191d5..cd77109a3 100644 --- a/lib/Api/CustomerShippingAddressApi.php +++ b/lib/Api/CustomerShippingAddressApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/DecisionManagerApi.php b/lib/Api/DecisionManagerApi.php index 96f680948..69f48f1d7 100644 --- a/lib/Api/DecisionManagerApi.php +++ b/lib/Api/DecisionManagerApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/DownloadDTDApi.php b/lib/Api/DownloadDTDApi.php index 9dbc4a763..b178d9c9c 100644 --- a/lib/Api/DownloadDTDApi.php +++ b/lib/Api/DownloadDTDApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/DownloadXSDApi.php b/lib/Api/DownloadXSDApi.php index b3e757be4..0fc6bb6cc 100644 --- a/lib/Api/DownloadXSDApi.php +++ b/lib/Api/DownloadXSDApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/EMVTagDetailsApi.php b/lib/Api/EMVTagDetailsApi.php index bf749bbfc..b4886fc4e 100644 --- a/lib/Api/EMVTagDetailsApi.php +++ b/lib/Api/EMVTagDetailsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/InstrumentIdentifierApi.php b/lib/Api/InstrumentIdentifierApi.php index b48e575bf..6984b809e 100644 --- a/lib/Api/InstrumentIdentifierApi.php +++ b/lib/Api/InstrumentIdentifierApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/InterchangeClearingLevelDetailsApi.php b/lib/Api/InterchangeClearingLevelDetailsApi.php index c58fe0329..88c2d5958 100644 --- a/lib/Api/InterchangeClearingLevelDetailsApi.php +++ b/lib/Api/InterchangeClearingLevelDetailsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/InvoiceSettingsApi.php b/lib/Api/InvoiceSettingsApi.php index a8b049ffe..bffeaf5f8 100644 --- a/lib/Api/InvoiceSettingsApi.php +++ b/lib/Api/InvoiceSettingsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/InvoicesApi.php b/lib/Api/InvoicesApi.php index 4f8ce0a36..e07f6e2fc 100644 --- a/lib/Api/InvoicesApi.php +++ b/lib/Api/InvoicesApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/KeymanagementApi.php b/lib/Api/KeymanagementApi.php index 239c3d1f1..b3ae07a0b 100644 --- a/lib/Api/KeymanagementApi.php +++ b/lib/Api/KeymanagementApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/KeymanagementpasswordApi.php b/lib/Api/KeymanagementpasswordApi.php index ec3808a29..8d3b19e1c 100644 --- a/lib/Api/KeymanagementpasswordApi.php +++ b/lib/Api/KeymanagementpasswordApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/KeymanagementpgpApi.php b/lib/Api/KeymanagementpgpApi.php index 1341c6cc2..d0b3be569 100644 --- a/lib/Api/KeymanagementpgpApi.php +++ b/lib/Api/KeymanagementpgpApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/KeymanagementscmpApi.php b/lib/Api/KeymanagementscmpApi.php index 447e1316a..5e97b1c6f 100644 --- a/lib/Api/KeymanagementscmpApi.php +++ b/lib/Api/KeymanagementscmpApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ManageWebhooksApi.php b/lib/Api/ManageWebhooksApi.php index c16d7c5dc..8f24844aa 100644 --- a/lib/Api/ManageWebhooksApi.php +++ b/lib/Api/ManageWebhooksApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/MerchantBoardingApi.php b/lib/Api/MerchantBoardingApi.php index 8ccbd3f5e..de07ed38d 100644 --- a/lib/Api/MerchantBoardingApi.php +++ b/lib/Api/MerchantBoardingApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/MicroformIntegrationApi.php b/lib/Api/MicroformIntegrationApi.php index ae8182032..515210717 100644 --- a/lib/Api/MicroformIntegrationApi.php +++ b/lib/Api/MicroformIntegrationApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/NetFundingsApi.php b/lib/Api/NetFundingsApi.php index f1d43f1a0..e59298015 100644 --- a/lib/Api/NetFundingsApi.php +++ b/lib/Api/NetFundingsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/NotificationOfChangesApi.php b/lib/Api/NotificationOfChangesApi.php index 1855e39a5..8f584c9bd 100644 --- a/lib/Api/NotificationOfChangesApi.php +++ b/lib/Api/NotificationOfChangesApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/PayerAuthenticationApi.php b/lib/Api/PayerAuthenticationApi.php index dcb153fce..5e745ae4e 100644 --- a/lib/Api/PayerAuthenticationApi.php +++ b/lib/Api/PayerAuthenticationApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/PaymentBatchSummariesApi.php b/lib/Api/PaymentBatchSummariesApi.php index 380f6258f..c61cbaf5c 100644 --- a/lib/Api/PaymentBatchSummariesApi.php +++ b/lib/Api/PaymentBatchSummariesApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/PaymentInstrumentApi.php b/lib/Api/PaymentInstrumentApi.php index f6f4e2736..1ec4c63c1 100644 --- a/lib/Api/PaymentInstrumentApi.php +++ b/lib/Api/PaymentInstrumentApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/PaymentsApi.php b/lib/Api/PaymentsApi.php index 60d9c6d1d..a84b056a5 100644 --- a/lib/Api/PaymentsApi.php +++ b/lib/Api/PaymentsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/PayoutsApi.php b/lib/Api/PayoutsApi.php index 1a1d4cfda..773e180b8 100644 --- a/lib/Api/PayoutsApi.php +++ b/lib/Api/PayoutsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/PlansApi.php b/lib/Api/PlansApi.php index 0d9557827..65c1ca268 100644 --- a/lib/Api/PlansApi.php +++ b/lib/Api/PlansApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/PurchaseAndRefundDetailsApi.php b/lib/Api/PurchaseAndRefundDetailsApi.php index ff031f89a..ca85de873 100644 --- a/lib/Api/PurchaseAndRefundDetailsApi.php +++ b/lib/Api/PurchaseAndRefundDetailsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/PushFundsApi.php b/lib/Api/PushFundsApi.php index 0efb5449d..cb29b60b5 100644 --- a/lib/Api/PushFundsApi.php +++ b/lib/Api/PushFundsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/RefundApi.php b/lib/Api/RefundApi.php index 3ddd5162b..b2366be48 100644 --- a/lib/Api/RefundApi.php +++ b/lib/Api/RefundApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ReplayWebhooksApi.php b/lib/Api/ReplayWebhooksApi.php index 955753d5d..ac4173249 100644 --- a/lib/Api/ReplayWebhooksApi.php +++ b/lib/Api/ReplayWebhooksApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ReportDefinitionsApi.php b/lib/Api/ReportDefinitionsApi.php index f2e712ead..a97c40cad 100644 --- a/lib/Api/ReportDefinitionsApi.php +++ b/lib/Api/ReportDefinitionsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ReportDownloadsApi.php b/lib/Api/ReportDownloadsApi.php index 561d440b3..91581d885 100644 --- a/lib/Api/ReportDownloadsApi.php +++ b/lib/Api/ReportDownloadsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ReportSubscriptionsApi.php b/lib/Api/ReportSubscriptionsApi.php index 99c8cf558..cd5877d40 100644 --- a/lib/Api/ReportSubscriptionsApi.php +++ b/lib/Api/ReportSubscriptionsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ReportsApi.php b/lib/Api/ReportsApi.php index a69486c40..6ab4ae117 100644 --- a/lib/Api/ReportsApi.php +++ b/lib/Api/ReportsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/RetrievalDetailsApi.php b/lib/Api/RetrievalDetailsApi.php index f43b58f05..914119149 100644 --- a/lib/Api/RetrievalDetailsApi.php +++ b/lib/Api/RetrievalDetailsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/RetrievalSummariesApi.php b/lib/Api/RetrievalSummariesApi.php index 9e23fa9f1..0ae40d25f 100644 --- a/lib/Api/RetrievalSummariesApi.php +++ b/lib/Api/RetrievalSummariesApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/ReversalApi.php b/lib/Api/ReversalApi.php index 2295d533b..3262eb441 100644 --- a/lib/Api/ReversalApi.php +++ b/lib/Api/ReversalApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/SearchTransactionsApi.php b/lib/Api/SearchTransactionsApi.php index 01713327b..61e639872 100644 --- a/lib/Api/SearchTransactionsApi.php +++ b/lib/Api/SearchTransactionsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/SecureFileShareApi.php b/lib/Api/SecureFileShareApi.php index ab8f93a1b..5d3927713 100644 --- a/lib/Api/SecureFileShareApi.php +++ b/lib/Api/SecureFileShareApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/SubscriptionsApi.php b/lib/Api/SubscriptionsApi.php index 5630a8ef4..fd1e90f75 100644 --- a/lib/Api/SubscriptionsApi.php +++ b/lib/Api/SubscriptionsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/SymmetricKeyManagementApi.php b/lib/Api/SymmetricKeyManagementApi.php index 63f9040ab..f2d2a3cc6 100644 --- a/lib/Api/SymmetricKeyManagementApi.php +++ b/lib/Api/SymmetricKeyManagementApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/TaxesApi.php b/lib/Api/TaxesApi.php index 11ae5d063..6f0f7f5c1 100644 --- a/lib/Api/TaxesApi.php +++ b/lib/Api/TaxesApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/TokenApi.php b/lib/Api/TokenApi.php index 22e4c7255..048d219b7 100644 --- a/lib/Api/TokenApi.php +++ b/lib/Api/TokenApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/TransactionBatchesApi.php b/lib/Api/TransactionBatchesApi.php index 643e94e02..49cee3d3e 100644 --- a/lib/Api/TransactionBatchesApi.php +++ b/lib/Api/TransactionBatchesApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/TransactionDetailsApi.php b/lib/Api/TransactionDetailsApi.php index 61fbe30b1..00693dd31 100644 --- a/lib/Api/TransactionDetailsApi.php +++ b/lib/Api/TransactionDetailsApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/TransientTokenDataApi.php b/lib/Api/TransientTokenDataApi.php index 42122cafa..64ac8b2e5 100644 --- a/lib/Api/TransientTokenDataApi.php +++ b/lib/Api/TransientTokenDataApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/UnifiedCheckoutCaptureContextApi.php b/lib/Api/UnifiedCheckoutCaptureContextApi.php index 0299362eb..b173d8c58 100644 --- a/lib/Api/UnifiedCheckoutCaptureContextApi.php +++ b/lib/Api/UnifiedCheckoutCaptureContextApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/UserManagementApi.php b/lib/Api/UserManagementApi.php index d830010e0..269587f53 100644 --- a/lib/Api/UserManagementApi.php +++ b/lib/Api/UserManagementApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/UserManagementSearchApi.php b/lib/Api/UserManagementSearchApi.php index d2c76427a..c8bbad729 100644 --- a/lib/Api/UserManagementSearchApi.php +++ b/lib/Api/UserManagementSearchApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/VerificationApi.php b/lib/Api/VerificationApi.php index 4f91d3337..e10f06232 100644 --- a/lib/Api/VerificationApi.php +++ b/lib/Api/VerificationApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Api/VoidApi.php b/lib/Api/VoidApi.php index c92f5183c..20111ef0b 100644 --- a/lib/Api/VoidApi.php +++ b/lib/Api/VoidApi.php @@ -66,7 +66,7 @@ public function __construct(\CyberSource\ApiClient $apiClient = null) $this->apiClient = $apiClient; if (self::$logger === null) { - self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class()), $apiClient->merchantConfig->getLogConfiguration()); + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); } } diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php index 67940ed9b..171e63cc5 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php @@ -436,13 +436,13 @@ public function listInvalidProperties() if ($this->container['name'] === null) { $invalid_properties[] = "'name' can't be null"; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - // $invalid_properties[] = "invalid value for 'name', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { + $invalid_properties[] = "invalid value for 'name', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } - // if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - // $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { + $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } if (!is_null($this->container['description']) && !preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { $invalid_properties[] = "invalid value for 'description', must be conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."; @@ -495,12 +495,12 @@ public function valid() if ($this->container['name'] === null) { return false; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - // return false; - // } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - // return false; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { + return false; + } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { + return false; + } if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { return false; } @@ -544,9 +544,9 @@ public function getName() */ public function setName($name) { - // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $name))) { - // throw new \InvalidArgumentException("invalid value for $name when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } + if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $name))) { + throw new \InvalidArgumentException("invalid value for $name when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + } $this->container['name'] = $name; return $this; @@ -568,9 +568,9 @@ public function getDoingBusinessAs() */ public function setDoingBusinessAs($doingBusinessAs) { - // if (!is_null($doingBusinessAs) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $doingBusinessAs))) { - // throw new \InvalidArgumentException("invalid value for $doingBusinessAs when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } + if (!is_null($doingBusinessAs) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $doingBusinessAs))) { + throw new \InvalidArgumentException("invalid value for $doingBusinessAs when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + } $this->container['doingBusinessAs'] = $doingBusinessAs; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php index 600027395..007be6df7 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php @@ -194,13 +194,13 @@ public function listInvalidProperties() if ($this->container['locality'] === null) { $invalid_properties[] = "'locality' can't be null"; } - // if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - // $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { + $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; + } - // if (!is_null($this->container['administrativeArea']) && !preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - // $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; - // } + if (!is_null($this->container['administrativeArea']) && !preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { + $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; + } if (!is_null($this->container['postalCode']) && !preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { $invalid_properties[] = "invalid value for 'postalCode', must be conform to the pattern /^[0-9a-zA-Z ]*$/."; @@ -236,12 +236,12 @@ public function valid() if ($this->container['locality'] === null) { return false; } - // if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - // return false; - // } - // if (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - // return false; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { + return false; + } + if (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { + return false; + } if (!preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { return false; } @@ -337,9 +337,9 @@ public function getLocality() */ public function setLocality($locality) { - // if ((!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $locality))) { - // throw new \InvalidArgumentException("invalid value for $locality when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."); - // } + if ((!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $locality))) { + throw new \InvalidArgumentException("invalid value for $locality when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."); + } $this->container['locality'] = $locality; return $this; @@ -361,9 +361,9 @@ public function getAdministrativeArea() */ public function setAdministrativeArea($administrativeArea) { - // if (!is_null($administrativeArea) && (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $administrativeArea))) { - // throw new \InvalidArgumentException("invalid value for $administrativeArea when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."); - // } + if (!is_null($administrativeArea) && (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $administrativeArea))) { + throw new \InvalidArgumentException("invalid value for $administrativeArea when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."); + } $this->container['administrativeArea'] = $administrativeArea; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php index 6cb7d8e17..6bfe85757 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php @@ -170,20 +170,20 @@ public function listInvalidProperties() if ($this->container['firstName'] === null) { $invalid_properties[] = "'firstName' can't be null"; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - // $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { + $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } - // if (!is_null($this->container['middleName']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - // $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!is_null($this->container['middleName']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { + $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } if ($this->container['lastName'] === null) { $invalid_properties[] = "'lastName' can't be null"; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - // $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { + $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } if ($this->container['phoneNumber'] === null) { $invalid_properties[] = "'phoneNumber' can't be null"; @@ -214,18 +214,18 @@ public function valid() if ($this->container['firstName'] === null) { return false; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - // return false; - // } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - // return false; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { + return false; + } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { + return false; + } if ($this->container['lastName'] === null) { return false; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - // return false; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { + return false; + } if ($this->container['phoneNumber'] === null) { return false; } @@ -258,9 +258,9 @@ public function getFirstName() */ public function setFirstName($firstName) { - // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $firstName))) { - // throw new \InvalidArgumentException("invalid value for $firstName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } + if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $firstName))) { + throw new \InvalidArgumentException("invalid value for $firstName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + } $this->container['firstName'] = $firstName; return $this; @@ -282,9 +282,9 @@ public function getMiddleName() */ public function setMiddleName($middleName) { - // if (!is_null($middleName) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $middleName))) { - // throw new \InvalidArgumentException("invalid value for $middleName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } + if (!is_null($middleName) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $middleName))) { + throw new \InvalidArgumentException("invalid value for $middleName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + } $this->container['middleName'] = $middleName; return $this; @@ -306,9 +306,9 @@ public function getLastName() */ public function setLastName($lastName) { - // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $lastName))) { - // throw new \InvalidArgumentException("invalid value for $lastName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } + if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $lastName))) { + throw new \InvalidArgumentException("invalid value for $lastName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + } $this->container['lastName'] = $lastName; return $this; From 038fa3ab053002ec32fbc846731cadfc771d901a Mon Sep 17 00:00:00 2001 From: gnongsie Date: Fri, 24 May 2024 11:25:37 +0530 Subject: [PATCH 03/17] Commented out incorrect regex pattern check --- ...nizationInformationBusinessInformation.php | 36 ++++++------- ...nInformationBusinessInformationAddress.php | 36 ++++++------- ...tionBusinessInformationBusinessContact.php | 54 +++++++++---------- 3 files changed, 63 insertions(+), 63 deletions(-) diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php index 171e63cc5..862400fe1 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php @@ -436,13 +436,13 @@ public function listInvalidProperties() if ($this->container['name'] === null) { $invalid_properties[] = "'name' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - $invalid_properties[] = "invalid value for 'name', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } + // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { + // $invalid_properties[] = "invalid value for 'name', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // } - if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } + // if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { + // $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // } if (!is_null($this->container['description']) && !preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { $invalid_properties[] = "invalid value for 'description', must be conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."; @@ -495,12 +495,12 @@ public function valid() if ($this->container['name'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - return false; - } + // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { + // return false; + // } + // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { + // return false; + // } if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { return false; } @@ -544,9 +544,9 @@ public function getName() */ public function setName($name) { - if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $name))) { - throw new \InvalidArgumentException("invalid value for $name when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - } + // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $name))) { + // throw new \InvalidArgumentException("invalid value for $name when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // } $this->container['name'] = $name; return $this; @@ -568,9 +568,9 @@ public function getDoingBusinessAs() */ public function setDoingBusinessAs($doingBusinessAs) { - if (!is_null($doingBusinessAs) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $doingBusinessAs))) { - throw new \InvalidArgumentException("invalid value for $doingBusinessAs when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - } + // if (!is_null($doingBusinessAs) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $doingBusinessAs))) { + // throw new \InvalidArgumentException("invalid value for $doingBusinessAs when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // } $this->container['doingBusinessAs'] = $doingBusinessAs; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php index 007be6df7..266fa439b 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php @@ -194,13 +194,13 @@ public function listInvalidProperties() if ($this->container['locality'] === null) { $invalid_properties[] = "'locality' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; - } + // if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { + // $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; + // } - if (!is_null($this->container['administrativeArea']) && !preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; - } + // if (!is_null($this->container['administrativeArea']) && !preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { + // $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; + // } if (!is_null($this->container['postalCode']) && !preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { $invalid_properties[] = "invalid value for 'postalCode', must be conform to the pattern /^[0-9a-zA-Z ]*$/."; @@ -236,12 +236,12 @@ public function valid() if ($this->container['locality'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - return false; - } + // if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { + // return false; + // } + // if (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { + // return false; + // } if (!preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { return false; } @@ -337,9 +337,9 @@ public function getLocality() */ public function setLocality($locality) { - if ((!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $locality))) { - throw new \InvalidArgumentException("invalid value for $locality when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."); - } + // if ((!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $locality))) { + // throw new \InvalidArgumentException("invalid value for $locality when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."); + // } $this->container['locality'] = $locality; return $this; @@ -361,9 +361,9 @@ public function getAdministrativeArea() */ public function setAdministrativeArea($administrativeArea) { - if (!is_null($administrativeArea) && (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $administrativeArea))) { - throw new \InvalidArgumentException("invalid value for $administrativeArea when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."); - } + // if (!is_null($administrativeArea) && (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $administrativeArea))) { + // throw new \InvalidArgumentException("invalid value for $administrativeArea when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."); + // } $this->container['administrativeArea'] = $administrativeArea; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php index 6bfe85757..3e3870a3c 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php @@ -170,20 +170,20 @@ public function listInvalidProperties() if ($this->container['firstName'] === null) { $invalid_properties[] = "'firstName' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } + // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { + // $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // } - if (!is_null($this->container['middleName']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } + // if (!is_null($this->container['middleName']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { + // $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // } if ($this->container['lastName'] === null) { $invalid_properties[] = "'lastName' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } + // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { + // $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // } if ($this->container['phoneNumber'] === null) { $invalid_properties[] = "'phoneNumber' can't be null"; @@ -214,18 +214,18 @@ public function valid() if ($this->container['firstName'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - return false; - } + // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { + // return false; + // } + // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { + // return false; + // } if ($this->container['lastName'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - return false; - } + // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { + // return false; + // } if ($this->container['phoneNumber'] === null) { return false; } @@ -258,9 +258,9 @@ public function getFirstName() */ public function setFirstName($firstName) { - if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $firstName))) { - throw new \InvalidArgumentException("invalid value for $firstName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - } + // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $firstName))) { + // throw new \InvalidArgumentException("invalid value for $firstName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // } $this->container['firstName'] = $firstName; return $this; @@ -282,9 +282,9 @@ public function getMiddleName() */ public function setMiddleName($middleName) { - if (!is_null($middleName) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $middleName))) { - throw new \InvalidArgumentException("invalid value for $middleName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - } + // if (!is_null($middleName) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $middleName))) { + // throw new \InvalidArgumentException("invalid value for $middleName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // } $this->container['middleName'] = $middleName; return $this; @@ -306,9 +306,9 @@ public function getLastName() */ public function setLastName($lastName) { - if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $lastName))) { - throw new \InvalidArgumentException("invalid value for $lastName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - } + // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $lastName))) { + // throw new \InvalidArgumentException("invalid value for $lastName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // } $this->container['lastName'] = $lastName; return $this; From c0fd00ade3f1a9d3f8454a6eda6153a0bb146e97 Mon Sep 17 00:00:00 2001 From: gnongsie Date: Fri, 24 May 2024 11:31:25 +0530 Subject: [PATCH 04/17] Corrected indentation --- ...anizationInformationBusinessInformation.php | 10 +++++----- ...onInformationBusinessInformationAddress.php | 12 ++++++------ ...ationBusinessInformationBusinessContact.php | 18 +++++++++--------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php index 862400fe1..a60f9274b 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php @@ -441,7 +441,7 @@ public function listInvalidProperties() // } // if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - // $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; // } if (!is_null($this->container['description']) && !preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { @@ -496,10 +496,10 @@ public function valid() return false; } // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - // return false; + // return false; // } // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - // return false; + // return false; // } if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { return false; @@ -545,7 +545,7 @@ public function getName() public function setName($name) { // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $name))) { - // throw new \InvalidArgumentException("invalid value for $name when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // throw new \InvalidArgumentException("invalid value for $name when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); // } $this->container['name'] = $name; @@ -569,7 +569,7 @@ public function getDoingBusinessAs() public function setDoingBusinessAs($doingBusinessAs) { // if (!is_null($doingBusinessAs) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $doingBusinessAs))) { - // throw new \InvalidArgumentException("invalid value for $doingBusinessAs when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // throw new \InvalidArgumentException("invalid value for $doingBusinessAs when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); // } $this->container['doingBusinessAs'] = $doingBusinessAs; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php index 266fa439b..600027395 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php @@ -195,11 +195,11 @@ public function listInvalidProperties() $invalid_properties[] = "'locality' can't be null"; } // if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - // $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; + // $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; // } // if (!is_null($this->container['administrativeArea']) && !preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - // $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; + // $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; // } if (!is_null($this->container['postalCode']) && !preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { @@ -237,10 +237,10 @@ public function valid() return false; } // if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - // return false; + // return false; // } // if (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - // return false; + // return false; // } if (!preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { return false; @@ -338,7 +338,7 @@ public function getLocality() public function setLocality($locality) { // if ((!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $locality))) { - // throw new \InvalidArgumentException("invalid value for $locality when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."); + // throw new \InvalidArgumentException("invalid value for $locality when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."); // } $this->container['locality'] = $locality; @@ -362,7 +362,7 @@ public function getAdministrativeArea() public function setAdministrativeArea($administrativeArea) { // if (!is_null($administrativeArea) && (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $administrativeArea))) { - // throw new \InvalidArgumentException("invalid value for $administrativeArea when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."); + // throw new \InvalidArgumentException("invalid value for $administrativeArea when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."); // } $this->container['administrativeArea'] = $administrativeArea; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php index 3e3870a3c..6cb7d8e17 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php @@ -171,18 +171,18 @@ public function listInvalidProperties() $invalid_properties[] = "'firstName' can't be null"; } // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - // $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; // } // if (!is_null($this->container['middleName']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - // $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; // } if ($this->container['lastName'] === null) { $invalid_properties[] = "'lastName' can't be null"; } // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - // $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; // } if ($this->container['phoneNumber'] === null) { @@ -215,16 +215,16 @@ public function valid() return false; } // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - // return false; + // return false; // } // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - // return false; + // return false; // } if ($this->container['lastName'] === null) { return false; } // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - // return false; + // return false; // } if ($this->container['phoneNumber'] === null) { return false; @@ -259,7 +259,7 @@ public function getFirstName() public function setFirstName($firstName) { // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $firstName))) { - // throw new \InvalidArgumentException("invalid value for $firstName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // throw new \InvalidArgumentException("invalid value for $firstName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); // } $this->container['firstName'] = $firstName; @@ -283,7 +283,7 @@ public function getMiddleName() public function setMiddleName($middleName) { // if (!is_null($middleName) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $middleName))) { - // throw new \InvalidArgumentException("invalid value for $middleName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // throw new \InvalidArgumentException("invalid value for $middleName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); // } $this->container['middleName'] = $middleName; @@ -307,7 +307,7 @@ public function getLastName() public function setLastName($lastName) { // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $lastName))) { - // throw new \InvalidArgumentException("invalid value for $lastName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); + // throw new \InvalidArgumentException("invalid value for $lastName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); // } $this->container['lastName'] = $lastName; From bf73b797399efea15d3225dd98b028a1c40ef67a Mon Sep 17 00:00:00 2001 From: gnongsie Date: Fri, 24 May 2024 11:33:58 +0530 Subject: [PATCH 05/17] Corrected indentation --- ...1registrationsOrganizationInformationBusinessInformation.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php index a60f9274b..67940ed9b 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php @@ -441,7 +441,7 @@ public function listInvalidProperties() // } // if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - // $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + // $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; // } if (!is_null($this->container['description']) && !preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { From de6306e1cc0c9658947d3ec35a5dfe752239a07e Mon Sep 17 00:00:00 2001 From: monkumar Date: Mon, 3 Jun 2024 13:55:00 +0530 Subject: [PATCH 06/17] added new line at end --- lib/Authentication/Util/Cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/Authentication/Util/Cache.php b/lib/Authentication/Util/Cache.php index 7d4b097d2..9fc4b92f4 100644 --- a/lib/Authentication/Util/Cache.php +++ b/lib/Authentication/Util/Cache.php @@ -44,4 +44,4 @@ public function checkIfExistInCache($key) return false; } -} \ No newline at end of file +} From 784f29a4e35b0a43a7bb4af7a8c70035dfd28528 Mon Sep 17 00:00:00 2001 From: gaubansa Date: Thu, 13 Jun 2024 13:24:02 +0530 Subject: [PATCH 07/17] removing pattern validation --- generator/cybersource-php-template/model_generic.mustache | 7 ------- 1 file changed, 7 deletions(-) diff --git a/generator/cybersource-php-template/model_generic.mustache b/generator/cybersource-php-template/model_generic.mustache index 5eb6b87c5..400461d21 100644 --- a/generator/cybersource-php-template/model_generic.mustache +++ b/generator/cybersource-php-template/model_generic.mustache @@ -248,13 +248,6 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple } {{/isContainer}} {{/isEnum}} - {{#hasValidation}} - {{#pattern}} - if ({{^required}}!is_null(${{name}}) && {{/required}}(!preg_match("{{{pattern}}}", ${{name}}))) { - throw new \InvalidArgumentException("invalid value for ${{name}} when calling {{classname}}.{{operationId}}, must conform to the pattern {{{pattern}}}."); - } - {{/pattern}} - {{/hasValidation}} $this->container['{{name}}'] = ${{name}}; return $this; From b213a42a13cecbd2ff2f31863f1773d583d6cfd8 Mon Sep 17 00:00:00 2001 From: gaubansa Date: Thu, 13 Jun 2024 15:40:36 +0530 Subject: [PATCH 08/17] removing validation for query params --- .../cybersource-php-template/api.mustache | 22 +------------------ 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/generator/cybersource-php-template/api.mustache b/generator/cybersource-php-template/api.mustache index 9a5002b7e..5419722dc 100644 --- a/generator/cybersource-php-template/api.mustache +++ b/generator/cybersource-php-template/api.mustache @@ -142,27 +142,7 @@ use \{{invokerPackage}}\Logging\LogFactory as LogFactory; throw new \InvalidArgumentException('Missing the required parameter ${{paramName}} when calling {{operationId}}'); } {{/required}} - {{#hasValidation}} - {{#pattern}} - if ({{^required}}!is_null(${{paramName}}) && {{/required}}!preg_match("{{{pattern}}}", ${{paramName}})) { - self::$logger->error("InvalidArgumentException : Invalid value for \"{{paramName}}\" when calling {{classname}}.{{operationId}}, must conform to the pattern {{{pattern}}}."); - throw new \InvalidArgumentException('Invalid value for \"{{paramName}}\" when calling {{classname}}.{{operationId}}, must conform to the pattern {{{pattern}}}.'); - } - {{/pattern}} - {{#maxItems}} - if ({{^required}}!is_null(${{paramName}}) && {{/required}}(count(${{paramName}}) > {{maxItems}})) { - self::$logger->error("InvalidArgumentException : Invalid value for \"${{paramName}}\" when calling {{classname}}.{{operationId}}, number of items must be less than or equal to {{maxItems}}."); - throw new \InvalidArgumentException('Invalid value for "${{paramName}}" when calling {{classname}}.{{operationId}}, number of items must be less than or equal to {{maxItems}}.'); - } - {{/maxItems}} - {{#minItems}} - if ({{^required}}!is_null(${{paramName}}) && {{/required}}(count(${{paramName}}) < {{minItems}})) { - self::$logger->error("InvalidArgumentException : Invalid value for \"${{paramName}}\" when calling {{classname}}.{{operationId}}, number of items must be greater than or equal to {{minItems}}."); - throw new \InvalidArgumentException('Invalid value for "${{paramName}}" when calling {{classname}}.{{operationId}}, number of items must be greater than or equal to {{minItems}}.'); - } - {{/minItems}} - - {{/hasValidation}} + {{/allParams}} // parse inputs $resourcePath = "{{{path}}}"; From cca39a72238ec2a7ee5ffc25e0ca35ce0edb9708 Mon Sep 17 00:00:00 2001 From: gaubansa Date: Mon, 17 Jun 2024 12:28:31 +0530 Subject: [PATCH 09/17] removing pattern check from model class --- ...grationInformationTenantConfigurations.php | 3 -- ...v1registrationsOrganizationInformation.php | 6 --- ...nizationInformationBusinessInformation.php | 45 +++++----------- ...nInformationBusinessInformationAddress.php | 42 +++++---------- ...tionBusinessInformationBusinessContact.php | 51 +++++++------------ ...zationInformationKYCDepositBankAccount.php | 9 ---- ...strationsOrganizationInformationOwners.php | 27 ---------- .../CardProcessingConfigCommonProcessors.php | 3 -- lib/Model/CreateAdhocReportRequest.php | 12 ----- lib/Model/CreateReportSubscriptionRequest.php | 15 ------ ...grationInformationTenantConfigurations.php | 6 --- ...grationInformationTenantConfigurations.php | 6 --- ...neResponse2011ProductInformationSetups.php | 3 -- ...eInvoiceSettingsInformationHeaderStyle.php | 6 --- ...onfigCardTypesVerifiedByVisaCurrencies.php | 6 --- .../PredefinedSubscriptionRequestBean.php | 9 ---- ...atchesGet200ResponseTransactionBatches.php | 3 -- ...tsV1TransactionBatchesIdGet200Response.php | 3 -- ...bscriptionsGet200ResponseSubscriptions.php | 3 -- ...tEmvTags200ResponseEmvTagBreakdownList.php | 3 -- ...tEmvTags200ResponseEmvTagBreakdownList.php | 6 --- 21 files changed, 42 insertions(+), 225 deletions(-) diff --git a/lib/Model/Boardingv1registrationsIntegrationInformationTenantConfigurations.php b/lib/Model/Boardingv1registrationsIntegrationInformationTenantConfigurations.php index 4aa129eda..07bc32c0f 100644 --- a/lib/Model/Boardingv1registrationsIntegrationInformationTenantConfigurations.php +++ b/lib/Model/Boardingv1registrationsIntegrationInformationTenantConfigurations.php @@ -194,9 +194,6 @@ public function getSolutionId() */ public function setSolutionId($solutionId) { - if ((!preg_match("/^[0-9a-zA-Z_]+$/", $solutionId))) { - throw new \InvalidArgumentException("invalid value for $solutionId when calling Boardingv1registrationsIntegrationInformationTenantConfigurations., must conform to the pattern /^[0-9a-zA-Z_]+$/."); - } $this->container['solutionId'] = $solutionId; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformation.php b/lib/Model/Boardingv1registrationsOrganizationInformation.php index 8730e9999..d1c14afb7 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformation.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformation.php @@ -299,9 +299,6 @@ public function getOrganizationId() */ public function setOrganizationId($organizationId) { - if (!is_null($organizationId) && (!preg_match("/^[0-9a-zA-Z_]+$/", $organizationId))) { - throw new \InvalidArgumentException("invalid value for $organizationId when calling Boardingv1registrationsOrganizationInformation., must conform to the pattern /^[0-9a-zA-Z_]+$/."); - } $this->container['organizationId'] = $organizationId; return $this; @@ -323,9 +320,6 @@ public function getParentOrganizationId() */ public function setParentOrganizationId($parentOrganizationId) { - if (!is_null($parentOrganizationId) && (!preg_match("/^[0-9a-zA-Z_]+$/", $parentOrganizationId))) { - throw new \InvalidArgumentException("invalid value for $parentOrganizationId when calling Boardingv1registrationsOrganizationInformation., must conform to the pattern /^[0-9a-zA-Z_]+$/."); - } $this->container['parentOrganizationId'] = $parentOrganizationId; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php index 67940ed9b..5f65f3ec0 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php @@ -436,13 +436,13 @@ public function listInvalidProperties() if ($this->container['name'] === null) { $invalid_properties[] = "'name' can't be null"; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - // $invalid_properties[] = "invalid value for 'name', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { + $invalid_properties[] = "invalid value for 'name', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } - // if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - // $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { + $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } if (!is_null($this->container['description']) && !preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { $invalid_properties[] = "invalid value for 'description', must be conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."; @@ -495,12 +495,12 @@ public function valid() if ($this->container['name'] === null) { return false; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - // return false; - // } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - // return false; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { + return false; + } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { + return false; + } if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { return false; } @@ -544,9 +544,6 @@ public function getName() */ public function setName($name) { - // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $name))) { - // throw new \InvalidArgumentException("invalid value for $name when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } $this->container['name'] = $name; return $this; @@ -568,9 +565,6 @@ public function getDoingBusinessAs() */ public function setDoingBusinessAs($doingBusinessAs) { - // if (!is_null($doingBusinessAs) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $doingBusinessAs))) { - // throw new \InvalidArgumentException("invalid value for $doingBusinessAs when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } $this->container['doingBusinessAs'] = $doingBusinessAs; return $this; @@ -592,9 +586,6 @@ public function getDescription() */ public function setDescription($description) { - if (!is_null($description) && (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $description))) { - throw new \InvalidArgumentException("invalid value for $description when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."); - } $this->container['description'] = $description; return $this; @@ -688,9 +679,6 @@ public function getWebsiteUrl() */ public function setWebsiteUrl($websiteUrl) { - if (!is_null($websiteUrl) && (!preg_match("/\\b((?:https?:\/\/|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}\/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»“”‘’]))/", $websiteUrl))) { - throw new \InvalidArgumentException("invalid value for $websiteUrl when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /\\b((?:https?:\/\/|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}\/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»“”‘’]))/."); - } $this->container['websiteUrl'] = $websiteUrl; return $this; @@ -742,9 +730,6 @@ public function getTaxId() */ public function setTaxId($taxId) { - if (!is_null($taxId) && (!preg_match("/\\d{9}/", $taxId))) { - throw new \InvalidArgumentException("invalid value for $taxId when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /\\d{9}/."); - } $this->container['taxId'] = $taxId; return $this; @@ -766,9 +751,6 @@ public function getPhoneNumber() */ public function setPhoneNumber($phoneNumber) { - if (!is_null($phoneNumber) && (!preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $phoneNumber))) { - throw new \InvalidArgumentException("invalid value for $phoneNumber when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^[0-9a-zA-Z\\\\+\\\\-]+$/."); - } $this->container['phoneNumber'] = $phoneNumber; return $this; @@ -853,9 +835,6 @@ public function getMerchantCategoryCode() */ public function setMerchantCategoryCode($merchantCategoryCode) { - if (!is_null($merchantCategoryCode) && (!preg_match("/^\\d{3,4}$/", $merchantCategoryCode))) { - throw new \InvalidArgumentException("invalid value for $merchantCategoryCode when calling Boardingv1registrationsOrganizationInformationBusinessInformation., must conform to the pattern /^\\d{3,4}$/."); - } $this->container['merchantCategoryCode'] = $merchantCategoryCode; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php index 600027395..4ce93b02e 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php @@ -194,13 +194,13 @@ public function listInvalidProperties() if ($this->container['locality'] === null) { $invalid_properties[] = "'locality' can't be null"; } - // if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - // $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { + $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; + } - // if (!is_null($this->container['administrativeArea']) && !preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - // $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; - // } + if (!is_null($this->container['administrativeArea']) && !preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { + $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; + } if (!is_null($this->container['postalCode']) && !preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { $invalid_properties[] = "invalid value for 'postalCode', must be conform to the pattern /^[0-9a-zA-Z ]*$/."; @@ -236,12 +236,12 @@ public function valid() if ($this->container['locality'] === null) { return false; } - // if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - // return false; - // } - // if (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - // return false; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { + return false; + } + if (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { + return false; + } if (!preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { return false; } @@ -265,9 +265,6 @@ public function getCountry() */ public function setCountry($country) { - if ((!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $country))) { - throw new \InvalidArgumentException("invalid value for $country when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."); - } $this->container['country'] = $country; return $this; @@ -289,9 +286,6 @@ public function getAddress1() */ public function setAddress1($address1) { - if ((!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $address1))) { - throw new \InvalidArgumentException("invalid value for $address1 when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."); - } $this->container['address1'] = $address1; return $this; @@ -313,9 +307,6 @@ public function getAddress2() */ public function setAddress2($address2) { - if (!is_null($address2) && (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $address2))) { - throw new \InvalidArgumentException("invalid value for $address2 when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."); - } $this->container['address2'] = $address2; return $this; @@ -337,9 +328,6 @@ public function getLocality() */ public function setLocality($locality) { - // if ((!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $locality))) { - // throw new \InvalidArgumentException("invalid value for $locality when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."); - // } $this->container['locality'] = $locality; return $this; @@ -361,9 +349,6 @@ public function getAdministrativeArea() */ public function setAdministrativeArea($administrativeArea) { - // if (!is_null($administrativeArea) && (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $administrativeArea))) { - // throw new \InvalidArgumentException("invalid value for $administrativeArea when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."); - // } $this->container['administrativeArea'] = $administrativeArea; return $this; @@ -385,9 +370,6 @@ public function getPostalCode() */ public function setPostalCode($postalCode) { - if (!is_null($postalCode) && (!preg_match("/^[0-9a-zA-Z ]*$/", $postalCode))) { - throw new \InvalidArgumentException("invalid value for $postalCode when calling Boardingv1registrationsOrganizationInformationBusinessInformationAddress., must conform to the pattern /^[0-9a-zA-Z ]*$/."); - } $this->container['postalCode'] = $postalCode; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php index 6cb7d8e17..d9c259897 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php @@ -170,20 +170,20 @@ public function listInvalidProperties() if ($this->container['firstName'] === null) { $invalid_properties[] = "'firstName' can't be null"; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - // $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { + $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } - // if (!is_null($this->container['middleName']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - // $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!is_null($this->container['middleName']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { + $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } if ($this->container['lastName'] === null) { $invalid_properties[] = "'lastName' can't be null"; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - // $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { + $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; + } if ($this->container['phoneNumber'] === null) { $invalid_properties[] = "'phoneNumber' can't be null"; @@ -214,18 +214,18 @@ public function valid() if ($this->container['firstName'] === null) { return false; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - // return false; - // } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - // return false; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { + return false; + } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { + return false; + } if ($this->container['lastName'] === null) { return false; } - // if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - // return false; - // } + if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { + return false; + } if ($this->container['phoneNumber'] === null) { return false; } @@ -258,9 +258,6 @@ public function getFirstName() */ public function setFirstName($firstName) { - // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $firstName))) { - // throw new \InvalidArgumentException("invalid value for $firstName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } $this->container['firstName'] = $firstName; return $this; @@ -282,9 +279,6 @@ public function getMiddleName() */ public function setMiddleName($middleName) { - // if (!is_null($middleName) && (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $middleName))) { - // throw new \InvalidArgumentException("invalid value for $middleName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } $this->container['middleName'] = $middleName; return $this; @@ -306,9 +300,6 @@ public function getLastName() */ public function setLastName($lastName) { - // if ((!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $lastName))) { - // throw new \InvalidArgumentException("invalid value for $lastName when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."); - // } $this->container['lastName'] = $lastName; return $this; @@ -330,9 +321,6 @@ public function getPhoneNumber() */ public function setPhoneNumber($phoneNumber) { - if ((!preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $phoneNumber))) { - throw new \InvalidArgumentException("invalid value for $phoneNumber when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^[0-9a-zA-Z\\\\+\\\\-]+$/."); - } $this->container['phoneNumber'] = $phoneNumber; return $this; @@ -354,9 +342,6 @@ public function getEmail() */ public function setEmail($email) { - if ((!preg_match("/^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/", $email))) { - throw new \InvalidArgumentException("invalid value for $email when calling Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact., must conform to the pattern /^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/."); - } $this->container['email'] = $email; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.php b/lib/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.php index 58bcfd358..8a07e7243 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.php @@ -268,9 +268,6 @@ public function getAccountHolderName() */ public function setAccountHolderName($accountHolderName) { - if ((!preg_match("/^[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $accountHolderName))) { - throw new \InvalidArgumentException("invalid value for $accountHolderName when calling Boardingv1registrationsOrganizationInformationKYCDepositBankAccount., must conform to the pattern /^[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."); - } $this->container['accountHolderName'] = $accountHolderName; return $this; @@ -322,9 +319,6 @@ public function getAccountRoutingNumber() */ public function setAccountRoutingNumber($accountRoutingNumber) { - if ((!preg_match("/\\d{9}/", $accountRoutingNumber))) { - throw new \InvalidArgumentException("invalid value for $accountRoutingNumber when calling Boardingv1registrationsOrganizationInformationKYCDepositBankAccount., must conform to the pattern /\\d{9}/."); - } $this->container['accountRoutingNumber'] = $accountRoutingNumber; return $this; @@ -346,9 +340,6 @@ public function getAccountNumber() */ public function setAccountNumber($accountNumber) { - if ((!preg_match("/^\\d{5,17}$/", $accountNumber))) { - throw new \InvalidArgumentException("invalid value for $accountNumber when calling Boardingv1registrationsOrganizationInformationKYCDepositBankAccount., must conform to the pattern /^\\d{5,17}$/."); - } $this->container['accountNumber'] = $accountNumber; return $this; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationOwners.php b/lib/Model/Boardingv1registrationsOrganizationInformationOwners.php index da38907eb..aef204523 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationOwners.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationOwners.php @@ -376,9 +376,6 @@ public function getFirstName() */ public function setFirstName($firstName) { - if ((!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $firstName))) { - throw new \InvalidArgumentException("invalid value for $firstName when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."); - } $this->container['firstName'] = $firstName; return $this; @@ -400,9 +397,6 @@ public function getMiddleName() */ public function setMiddleName($middleName) { - if (!is_null($middleName) && (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $middleName))) { - throw new \InvalidArgumentException("invalid value for $middleName when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."); - } $this->container['middleName'] = $middleName; return $this; @@ -424,9 +418,6 @@ public function getLastName() */ public function setLastName($lastName) { - if ((!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $lastName))) { - throw new \InvalidArgumentException("invalid value for $lastName when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."); - } $this->container['lastName'] = $lastName; return $this; @@ -490,9 +481,6 @@ public function getSsn() */ public function setSsn($ssn) { - if (!is_null($ssn) && (!preg_match("/^\\d{3}-\\d{2}-\\d{4}$|^\\d{9,9}$/", $ssn))) { - throw new \InvalidArgumentException("invalid value for $ssn when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /^\\d{3}-\\d{2}-\\d{4}$|^\\d{9,9}$/."); - } $this->container['ssn'] = $ssn; return $this; @@ -514,9 +502,6 @@ public function getPassportNumber() */ public function setPassportNumber($passportNumber) { - if (!is_null($passportNumber) && (!preg_match("/^(?!^0+$)[a-zA-Z0-9]{3,20}$/", $passportNumber))) { - throw new \InvalidArgumentException("invalid value for $passportNumber when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /^(?!^0+$)[a-zA-Z0-9]{3,20}$/."); - } $this->container['passportNumber'] = $passportNumber; return $this; @@ -538,9 +523,6 @@ public function getPassportCountry() */ public function setPassportCountry($passportCountry) { - if (!is_null($passportCountry) && (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $passportCountry))) { - throw new \InvalidArgumentException("invalid value for $passportCountry when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."); - } $this->container['passportCountry'] = $passportCountry; return $this; @@ -562,9 +544,6 @@ public function getJobTitle() */ public function setJobTitle($jobTitle) { - if ((!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $jobTitle))) { - throw new \InvalidArgumentException("invalid value for $jobTitle when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."); - } $this->container['jobTitle'] = $jobTitle; return $this; @@ -628,9 +607,6 @@ public function getPhoneNumber() */ public function setPhoneNumber($phoneNumber) { - if ((!preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $phoneNumber))) { - throw new \InvalidArgumentException("invalid value for $phoneNumber when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /^[0-9a-zA-Z\\\\+\\\\-]+$/."); - } $this->container['phoneNumber'] = $phoneNumber; return $this; @@ -652,9 +628,6 @@ public function getEmail() */ public function setEmail($email) { - if ((!preg_match("/^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/", $email))) { - throw new \InvalidArgumentException("invalid value for $email when calling Boardingv1registrationsOrganizationInformationOwners., must conform to the pattern /^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/."); - } $this->container['email'] = $email; return $this; diff --git a/lib/Model/CardProcessingConfigCommonProcessors.php b/lib/Model/CardProcessingConfigCommonProcessors.php index a9f02737c..5cadd9a5f 100644 --- a/lib/Model/CardProcessingConfigCommonProcessors.php +++ b/lib/Model/CardProcessingConfigCommonProcessors.php @@ -1402,9 +1402,6 @@ public function getMerchantTier() */ public function setMerchantTier($merchantTier) { - if (!is_null($merchantTier) && (!preg_match("/^[0-9]+$/", $merchantTier))) { - throw new \InvalidArgumentException("invalid value for $merchantTier when calling CardProcessingConfigCommonProcessors., must conform to the pattern /^[0-9]+$/."); - } $this->container['merchantTier'] = $merchantTier; return $this; diff --git a/lib/Model/CreateAdhocReportRequest.php b/lib/Model/CreateAdhocReportRequest.php index f736de078..416d0c216 100644 --- a/lib/Model/CreateAdhocReportRequest.php +++ b/lib/Model/CreateAdhocReportRequest.php @@ -263,9 +263,6 @@ public function getOrganizationId() */ public function setOrganizationId($organizationId) { - if (!is_null($organizationId) && (!preg_match("/[a-zA-Z0-9-_]+/", $organizationId))) { - throw new \InvalidArgumentException("invalid value for $organizationId when calling CreateAdhocReportRequest., must conform to the pattern /[a-zA-Z0-9-_]+/."); - } $this->container['organizationId'] = $organizationId; return $this; @@ -287,9 +284,6 @@ public function getReportDefinitionName() */ public function setReportDefinitionName($reportDefinitionName) { - if (!is_null($reportDefinitionName) && (!preg_match("/[a-zA-Z0-9-]+/", $reportDefinitionName))) { - throw new \InvalidArgumentException("invalid value for $reportDefinitionName when calling CreateAdhocReportRequest., must conform to the pattern /[a-zA-Z0-9-]+/."); - } $this->container['reportDefinitionName'] = $reportDefinitionName; return $this; @@ -353,9 +347,6 @@ public function getReportName() */ public function setReportName($reportName) { - if (!is_null($reportName) && (!preg_match("/[a-zA-Z0-9-_ ]+/", $reportName))) { - throw new \InvalidArgumentException("invalid value for $reportName when calling CreateAdhocReportRequest., must conform to the pattern /[a-zA-Z0-9-_ ]+/."); - } $this->container['reportName'] = $reportName; return $this; @@ -482,9 +473,6 @@ public function getGroupName() */ public function setGroupName($groupName) { - if (!is_null($groupName) && (!preg_match("/[0-9]*/", $groupName))) { - throw new \InvalidArgumentException("invalid value for $groupName when calling CreateAdhocReportRequest., must conform to the pattern /[0-9]*/."); - } $this->container['groupName'] = $groupName; return $this; diff --git a/lib/Model/CreateReportSubscriptionRequest.php b/lib/Model/CreateReportSubscriptionRequest.php index 65ededee4..92147b87a 100644 --- a/lib/Model/CreateReportSubscriptionRequest.php +++ b/lib/Model/CreateReportSubscriptionRequest.php @@ -324,9 +324,6 @@ public function getOrganizationId() */ public function setOrganizationId($organizationId) { - if (!is_null($organizationId) && (!preg_match("/[a-zA-Z0-9-_]+/", $organizationId))) { - throw new \InvalidArgumentException("invalid value for $organizationId when calling CreateReportSubscriptionRequest., must conform to the pattern /[a-zA-Z0-9-_]+/."); - } $this->container['organizationId'] = $organizationId; return $this; @@ -348,9 +345,6 @@ public function getReportDefinitionName() */ public function setReportDefinitionName($reportDefinitionName) { - if ((!preg_match("/[a-zA-Z0-9-]+/", $reportDefinitionName))) { - throw new \InvalidArgumentException("invalid value for $reportDefinitionName when calling CreateReportSubscriptionRequest., must conform to the pattern /[a-zA-Z0-9-]+/."); - } $this->container['reportDefinitionName'] = $reportDefinitionName; return $this; @@ -435,9 +429,6 @@ public function getReportInterval() */ public function setReportInterval($reportInterval) { - if (!is_null($reportInterval) && (!preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $reportInterval))) { - throw new \InvalidArgumentException("invalid value for $reportInterval when calling CreateReportSubscriptionRequest., must conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/."); - } $this->container['reportInterval'] = $reportInterval; return $this; @@ -459,9 +450,6 @@ public function getReportName() */ public function setReportName($reportName) { - if ((!preg_match("/[a-zA-Z0-9-_ ]+/", $reportName))) { - throw new \InvalidArgumentException("invalid value for $reportName when calling CreateReportSubscriptionRequest., must conform to the pattern /[a-zA-Z0-9-_ ]+/."); - } $this->container['reportName'] = $reportName; return $this; @@ -588,9 +576,6 @@ public function getGroupName() */ public function setGroupName($groupName) { - if (!is_null($groupName) && (!preg_match("/[a-zA-Z0-9-_ ]+/", $groupName))) { - throw new \InvalidArgumentException("invalid value for $groupName when calling CreateReportSubscriptionRequest., must conform to the pattern /[a-zA-Z0-9-_ ]+/."); - } $this->container['groupName'] = $groupName; return $this; diff --git a/lib/Model/InlineResponse2002IntegrationInformationTenantConfigurations.php b/lib/Model/InlineResponse2002IntegrationInformationTenantConfigurations.php index 9ceaacce6..e3b7e0a31 100644 --- a/lib/Model/InlineResponse2002IntegrationInformationTenantConfigurations.php +++ b/lib/Model/InlineResponse2002IntegrationInformationTenantConfigurations.php @@ -241,9 +241,6 @@ public function getSolutionId() */ public function setSolutionId($solutionId) { - if (!is_null($solutionId) && (!preg_match("/^[0-9a-zA-Z_]+$/", $solutionId))) { - throw new \InvalidArgumentException("invalid value for $solutionId when calling InlineResponse2002IntegrationInformationTenantConfigurations., must conform to the pattern /^[0-9a-zA-Z_]+$/."); - } $this->container['solutionId'] = $solutionId; return $this; @@ -265,9 +262,6 @@ public function getTenantConfigurationId() */ public function setTenantConfigurationId($tenantConfigurationId) { - if (!is_null($tenantConfigurationId) && (!preg_match("/^[0-9a-zA-Z_]+$/", $tenantConfigurationId))) { - throw new \InvalidArgumentException("invalid value for $tenantConfigurationId when calling InlineResponse2002IntegrationInformationTenantConfigurations., must conform to the pattern /^[0-9a-zA-Z_]+$/."); - } $this->container['tenantConfigurationId'] = $tenantConfigurationId; return $this; diff --git a/lib/Model/InlineResponse2011IntegrationInformationTenantConfigurations.php b/lib/Model/InlineResponse2011IntegrationInformationTenantConfigurations.php index 265a63f2e..dc48e0b17 100644 --- a/lib/Model/InlineResponse2011IntegrationInformationTenantConfigurations.php +++ b/lib/Model/InlineResponse2011IntegrationInformationTenantConfigurations.php @@ -235,9 +235,6 @@ public function getSolutionId() */ public function setSolutionId($solutionId) { - if (!is_null($solutionId) && (!preg_match("/^[0-9a-zA-Z_]+$/", $solutionId))) { - throw new \InvalidArgumentException("invalid value for $solutionId when calling InlineResponse2011IntegrationInformationTenantConfigurations., must conform to the pattern /^[0-9a-zA-Z_]+$/."); - } $this->container['solutionId'] = $solutionId; return $this; @@ -259,9 +256,6 @@ public function getTenantConfigurationId() */ public function setTenantConfigurationId($tenantConfigurationId) { - if (!is_null($tenantConfigurationId) && (!preg_match("/^[0-9a-zA-Z_]+$/", $tenantConfigurationId))) { - throw new \InvalidArgumentException("invalid value for $tenantConfigurationId when calling InlineResponse2011IntegrationInformationTenantConfigurations., must conform to the pattern /^[0-9a-zA-Z_]+$/."); - } $this->container['tenantConfigurationId'] = $tenantConfigurationId; return $this; diff --git a/lib/Model/InlineResponse2011ProductInformationSetups.php b/lib/Model/InlineResponse2011ProductInformationSetups.php index 9252a4199..174f44b2a 100644 --- a/lib/Model/InlineResponse2011ProductInformationSetups.php +++ b/lib/Model/InlineResponse2011ProductInformationSetups.php @@ -188,9 +188,6 @@ public function getOrganizationId() */ public function setOrganizationId($organizationId) { - if (!is_null($organizationId) && (!preg_match("/^[0-9a-zA-Z]+$/", $organizationId))) { - throw new \InvalidArgumentException("invalid value for $organizationId when calling InlineResponse2011ProductInformationSetups., must conform to the pattern /^[0-9a-zA-Z]+$/."); - } $this->container['organizationId'] = $organizationId; return $this; diff --git a/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.php b/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.php index 5982fb03e..826b5091f 100644 --- a/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.php +++ b/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.php @@ -195,9 +195,6 @@ public function getFontColor() */ public function setFontColor($fontColor) { - if (!is_null($fontColor) && (!preg_match("/^#(?:[0-9a-fA-F]{3}){1,2}$/", $fontColor))) { - throw new \InvalidArgumentException("invalid value for $fontColor when calling InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle., must conform to the pattern /^#(?:[0-9a-fA-F]{3}){1,2}$/."); - } $this->container['fontColor'] = $fontColor; return $this; @@ -219,9 +216,6 @@ public function getBackgroundColor() */ public function setBackgroundColor($backgroundColor) { - if (!is_null($backgroundColor) && (!preg_match("/^#(?:[0-9a-fA-F]{3}){1,2}$/", $backgroundColor))) { - throw new \InvalidArgumentException("invalid value for $backgroundColor when calling InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle., must conform to the pattern /^#(?:[0-9a-fA-F]{3}){1,2}$/."); - } $this->container['backgroundColor'] = $backgroundColor; return $this; diff --git a/lib/Model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies.php b/lib/Model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies.php index 260a51e2e..1725e17eb 100644 --- a/lib/Model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies.php +++ b/lib/Model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies.php @@ -222,9 +222,6 @@ public function getAcquirerId() */ public function setAcquirerId($acquirerId) { - if (!is_null($acquirerId) && (!preg_match("/^[a-zA-Z0-9]{6,20}$/", $acquirerId))) { - throw new \InvalidArgumentException("invalid value for $acquirerId when calling PayerAuthConfigCardTypesVerifiedByVisaCurrencies., must conform to the pattern /^[a-zA-Z0-9]{6,20}$/."); - } $this->container['acquirerId'] = $acquirerId; return $this; @@ -246,9 +243,6 @@ public function getProcessorMerchantId() */ public function setProcessorMerchantId($processorMerchantId) { - if (!is_null($processorMerchantId) && (!preg_match("/^[a-zA-Z0-9]{6,35}$/", $processorMerchantId))) { - throw new \InvalidArgumentException("invalid value for $processorMerchantId when calling PayerAuthConfigCardTypesVerifiedByVisaCurrencies., must conform to the pattern /^[a-zA-Z0-9]{6,35}$/."); - } $this->container['processorMerchantId'] = $processorMerchantId; return $this; diff --git a/lib/Model/PredefinedSubscriptionRequestBean.php b/lib/Model/PredefinedSubscriptionRequestBean.php index f319a92d1..40f4ff1d4 100644 --- a/lib/Model/PredefinedSubscriptionRequestBean.php +++ b/lib/Model/PredefinedSubscriptionRequestBean.php @@ -262,9 +262,6 @@ public function getReportDefinitionName() */ public function setReportDefinitionName($reportDefinitionName) { - if ((!preg_match("/[a-zA-Z]+/", $reportDefinitionName))) { - throw new \InvalidArgumentException("invalid value for $reportDefinitionName when calling PredefinedSubscriptionRequestBean., must conform to the pattern /[a-zA-Z]+/."); - } $this->container['reportDefinitionName'] = $reportDefinitionName; return $this; @@ -307,9 +304,6 @@ public function getReportName() */ public function setReportName($reportName) { - if (!is_null($reportName) && (!preg_match("/[a-zA-Z0-9-_ ]+/", $reportName))) { - throw new \InvalidArgumentException("invalid value for $reportName when calling PredefinedSubscriptionRequestBean., must conform to the pattern /[a-zA-Z0-9-_ ]+/."); - } $this->container['reportName'] = $reportName; return $this; @@ -373,9 +367,6 @@ public function getReportInterval() */ public function setReportInterval($reportInterval) { - if (!is_null($reportInterval) && (!preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $reportInterval))) { - throw new \InvalidArgumentException("invalid value for $reportInterval when calling PredefinedSubscriptionRequestBean., must conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/."); - } $this->container['reportInterval'] = $reportInterval; return $this; diff --git a/lib/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.php b/lib/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.php index 0156d44d0..9c8b22842 100644 --- a/lib/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.php +++ b/lib/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.php @@ -218,9 +218,6 @@ public function getId() */ public function setId($id) { - if (!is_null($id) && (!preg_match("/^[a-zA-Z0-9_+-]*$/", $id))) { - throw new \InvalidArgumentException("invalid value for $id when calling PtsV1TransactionBatchesGet200ResponseTransactionBatches., must conform to the pattern /^[a-zA-Z0-9_+-]*$/."); - } $this->container['id'] = $id; return $this; diff --git a/lib/Model/PtsV1TransactionBatchesIdGet200Response.php b/lib/Model/PtsV1TransactionBatchesIdGet200Response.php index 167e6e123..9e54adf50 100644 --- a/lib/Model/PtsV1TransactionBatchesIdGet200Response.php +++ b/lib/Model/PtsV1TransactionBatchesIdGet200Response.php @@ -224,9 +224,6 @@ public function getId() */ public function setId($id) { - if (!is_null($id) && (!preg_match("/^[a-zA-Z0-9_+-]*$/", $id))) { - throw new \InvalidArgumentException("invalid value for $id when calling PtsV1TransactionBatchesIdGet200Response., must conform to the pattern /^[a-zA-Z0-9_+-]*$/."); - } $this->container['id'] = $id; return $this; diff --git a/lib/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.php b/lib/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.php index cac94640e..7b26bd619 100644 --- a/lib/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.php +++ b/lib/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.php @@ -366,9 +366,6 @@ public function getReportInterval() */ public function setReportInterval($reportInterval) { - if (!is_null($reportInterval) && (!preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $reportInterval))) { - throw new \InvalidArgumentException("invalid value for $reportInterval when calling ReportingV3ReportSubscriptionsGet200ResponseSubscriptions., must conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/."); - } $this->container['reportInterval'] = $reportInterval; return $this; diff --git a/lib/Model/TssV2GetEmvTags200ResponseEmvTagBreakdownList.php b/lib/Model/TssV2GetEmvTags200ResponseEmvTagBreakdownList.php index 1bde506df..7c83bca7f 100644 --- a/lib/Model/TssV2GetEmvTags200ResponseEmvTagBreakdownList.php +++ b/lib/Model/TssV2GetEmvTags200ResponseEmvTagBreakdownList.php @@ -188,9 +188,6 @@ public function getTag() */ public function setTag($tag) { - if (!is_null($tag) && (!preg_match("/^[0-9A-F]*$/", $tag))) { - throw new \InvalidArgumentException("invalid value for $tag when calling TssV2GetEmvTags200ResponseEmvTagBreakdownList., must conform to the pattern /^[0-9A-F]*$/."); - } $this->container['tag'] = $tag; return $this; diff --git a/lib/Model/TssV2PostEmvTags200ResponseEmvTagBreakdownList.php b/lib/Model/TssV2PostEmvTags200ResponseEmvTagBreakdownList.php index 6875c456a..6a465cd27 100644 --- a/lib/Model/TssV2PostEmvTags200ResponseEmvTagBreakdownList.php +++ b/lib/Model/TssV2PostEmvTags200ResponseEmvTagBreakdownList.php @@ -213,9 +213,6 @@ public function getTag() */ public function setTag($tag) { - if (!is_null($tag) && (!preg_match("/^[0-9A-F]*$/", $tag))) { - throw new \InvalidArgumentException("invalid value for $tag when calling TssV2PostEmvTags200ResponseEmvTagBreakdownList., must conform to the pattern /^[0-9A-F]*$/."); - } $this->container['tag'] = $tag; return $this; @@ -279,9 +276,6 @@ public function getValue() */ public function setValue($value) { - if (!is_null($value) && (!preg_match("/^[0-9A-F|X]*$/", $value))) { - throw new \InvalidArgumentException("invalid value for $value when calling TssV2PostEmvTags200ResponseEmvTagBreakdownList., must conform to the pattern /^[0-9A-F|X]*$/."); - } $this->container['value'] = $value; return $this; From ed3e278c80781c8b1438962ac9dec2e974bb4e11 Mon Sep 17 00:00:00 2001 From: gaubansa Date: Mon, 17 Jun 2024 12:29:02 +0530 Subject: [PATCH 10/17] removing pattern check for query param --- lib/Api/AsymmetricKeyManagementApi.php | 5 +++ lib/Api/BatchesApi.php | 19 +++----- lib/Api/BillingAgreementsApi.php | 5 +++ lib/Api/CaptureApi.php | 2 + lib/Api/ChargebackDetailsApi.php | 8 ++-- lib/Api/ChargebackSummariesApi.php | 8 ++-- lib/Api/ConversionDetailsApi.php | 8 ++-- lib/Api/CreateNewWebhooksApi.php | 16 +++---- lib/Api/CreditApi.php | 1 + lib/Api/CustomerApi.php | 18 ++++---- lib/Api/CustomerPaymentInstrumentApi.php | 34 +++++++------- lib/Api/CustomerShippingAddressApi.php | 34 +++++++------- lib/Api/DecisionManagerApi.php | 9 ++++ lib/Api/DownloadDTDApi.php | 1 + lib/Api/DownloadXSDApi.php | 1 + lib/Api/EMVTagDetailsApi.php | 1 + lib/Api/InstrumentIdentifierApi.php | 31 +++++++------ .../InterchangeClearingLevelDetailsApi.php | 8 ++-- lib/Api/InvoiceSettingsApi.php | 1 + lib/Api/InvoicesApi.php | 9 ++++ lib/Api/KeymanagementApi.php | 18 ++++---- lib/Api/KeymanagementpasswordApi.php | 2 + lib/Api/KeymanagementpgpApi.php | 2 + lib/Api/KeymanagementscmpApi.php | 2 + lib/Api/ManageWebhooksApi.php | 21 ++++----- lib/Api/MerchantBoardingApi.php | 3 ++ lib/Api/MicroformIntegrationApi.php | 1 + lib/Api/NetFundingsApi.php | 9 ++-- lib/Api/NotificationOfChangesApi.php | 2 + lib/Api/PayerAuthenticationApi.php | 3 ++ lib/Api/PaymentBatchSummariesApi.php | 12 ++--- lib/Api/PaymentInstrumentApi.php | 18 ++++---- lib/Api/PaymentsApi.php | 10 +++++ lib/Api/PayoutsApi.php | 1 + lib/Api/PlansApi.php | 12 +++++ lib/Api/PurchaseAndRefundDetailsApi.php | 14 +++--- lib/Api/PushFundsApi.php | 7 +++ lib/Api/RefundApi.php | 4 ++ lib/Api/ReplayWebhooksApi.php | 2 + lib/Api/ReportDefinitionsApi.php | 16 +++---- lib/Api/ReportDownloadsApi.php | 8 ++-- lib/Api/ReportSubscriptionsApi.php | 44 ++++--------------- lib/Api/ReportsApi.php | 28 ++++++------ lib/Api/RetrievalDetailsApi.php | 8 ++-- lib/Api/RetrievalSummariesApi.php | 8 ++-- lib/Api/ReversalApi.php | 3 ++ lib/Api/SearchTransactionsApi.php | 2 + lib/Api/SecureFileShareApi.php | 21 +++------ lib/Api/SubscriptionsApi.php | 11 +++++ lib/Api/SymmetricKeyManagementApi.php | 5 +++ lib/Api/TaxesApi.php | 3 ++ lib/Api/TokenApi.php | 5 ++- lib/Api/TransactionBatchesApi.php | 6 +++ lib/Api/TransactionDetailsApi.php | 1 + lib/Api/TransientTokenDataApi.php | 2 + lib/Api/UnifiedCheckoutCaptureContextApi.php | 1 + lib/Api/UserManagementApi.php | 4 ++ lib/Api/UserManagementSearchApi.php | 1 + lib/Api/VerificationApi.php | 2 + lib/Api/VoidApi.php | 9 ++++ 60 files changed, 317 insertions(+), 233 deletions(-) diff --git a/lib/Api/AsymmetricKeyManagementApi.php b/lib/Api/AsymmetricKeyManagementApi.php index ac7948c55..c8088f28c 100644 --- a/lib/Api/AsymmetricKeyManagementApi.php +++ b/lib/Api/AsymmetricKeyManagementApi.php @@ -127,6 +127,7 @@ public function createP12KeysWithHttpInfo($createP12KeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createP12KeysRequest when calling createP12Keys"); throw new \InvalidArgumentException('Missing the required parameter $createP12KeysRequest when calling createP12Keys'); } + // parse inputs $resourcePath = "/kms/v2/keys-asym"; $httpBody = ''; @@ -240,6 +241,7 @@ public function deleteBulkP12KeysWithHttpInfo($deleteBulkP12KeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $deleteBulkP12KeysRequest when calling deleteBulkP12Keys"); throw new \InvalidArgumentException('Missing the required parameter $deleteBulkP12KeysRequest when calling deleteBulkP12Keys'); } + // parse inputs $resourcePath = "/kms/v2/keys-asym/deletes"; $httpBody = ''; @@ -353,6 +355,7 @@ public function getP12KeyDetailsWithHttpInfo($keyId) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling getP12KeyDetails"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling getP12KeyDetails'); } + // parse inputs $resourcePath = "/kms/v2/keys-asym/{keyId}"; $httpBody = ''; @@ -469,11 +472,13 @@ public function updateAsymKeyWithHttpInfo($keyId, $updateAsymKeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling updateAsymKey"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling updateAsymKey'); } + // verify the required parameter 'updateAsymKeysRequest' is set if ($updateAsymKeysRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updateAsymKeysRequest when calling updateAsymKey"); throw new \InvalidArgumentException('Missing the required parameter $updateAsymKeysRequest when calling updateAsymKey'); } + // parse inputs $resourcePath = "/kms/v2/keys-asym/{keyId}"; $httpBody = ''; diff --git a/lib/Api/BatchesApi.php b/lib/Api/BatchesApi.php index a56182bb4..4f33cb2b7 100644 --- a/lib/Api/BatchesApi.php +++ b/lib/Api/BatchesApi.php @@ -127,11 +127,7 @@ public function getBatchReportWithHttpInfo($batchId) self::$logger->error("InvalidArgumentException : Missing the required parameter $batchId when calling getBatchReport"); throw new \InvalidArgumentException('Missing the required parameter $batchId when calling getBatchReport'); } - if (!preg_match("/^[0-9]*$/", $batchId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"batchId\" when calling BatchesApi.getBatchReport, must conform to the pattern /^[0-9]*$/."); - throw new \InvalidArgumentException('Invalid value for \"batchId\" when calling BatchesApi.getBatchReport, must conform to the pattern /^[0-9]*$/.'); - } - + // parse inputs $resourcePath = "/accountupdater/v1/batches/{batchId}/report"; $httpBody = ''; @@ -242,11 +238,7 @@ public function getBatchStatusWithHttpInfo($batchId) self::$logger->error("InvalidArgumentException : Missing the required parameter $batchId when calling getBatchStatus"); throw new \InvalidArgumentException('Missing the required parameter $batchId when calling getBatchStatus'); } - if (!preg_match("/^[0-9]*$/", $batchId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"batchId\" when calling BatchesApi.getBatchStatus, must conform to the pattern /^[0-9]*$/."); - throw new \InvalidArgumentException('Invalid value for \"batchId\" when calling BatchesApi.getBatchStatus, must conform to the pattern /^[0-9]*$/.'); - } - + // parse inputs $resourcePath = "/accountupdater/v1/batches/{batchId}/status"; $httpBody = ''; @@ -358,8 +350,10 @@ public function getBatchesList($offset = '0', $limit = '20', $fromDate = null, $ */ public function getBatchesListWithHttpInfo($offset = '0', $limit = '20', $fromDate = null, $toDate = null) { - - + + + + // parse inputs $resourcePath = "/accountupdater/v1/batches"; $httpBody = ''; @@ -486,6 +480,7 @@ public function postBatchWithHttpInfo($body) self::$logger->error("InvalidArgumentException : Missing the required parameter $body when calling postBatch"); throw new \InvalidArgumentException('Missing the required parameter $body when calling postBatch'); } + // parse inputs $resourcePath = "/accountupdater/v1/batches"; $httpBody = ''; diff --git a/lib/Api/BillingAgreementsApi.php b/lib/Api/BillingAgreementsApi.php index aee1e98f1..67ef37a1d 100644 --- a/lib/Api/BillingAgreementsApi.php +++ b/lib/Api/BillingAgreementsApi.php @@ -129,11 +129,13 @@ public function billingAgreementsDeRegistrationWithHttpInfo($modifyBillingAgreem self::$logger->error("InvalidArgumentException : Missing the required parameter $modifyBillingAgreement when calling billingAgreementsDeRegistration"); throw new \InvalidArgumentException('Missing the required parameter $modifyBillingAgreement when calling billingAgreementsDeRegistration'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling billingAgreementsDeRegistration"); throw new \InvalidArgumentException('Missing the required parameter $id when calling billingAgreementsDeRegistration'); } + // parse inputs $resourcePath = "/pts/v2/billing-agreements/{id}"; $httpBody = ''; @@ -257,11 +259,13 @@ public function billingAgreementsIntimationWithHttpInfo($intimateBillingAgreemen self::$logger->error("InvalidArgumentException : Missing the required parameter $intimateBillingAgreement when calling billingAgreementsIntimation"); throw new \InvalidArgumentException('Missing the required parameter $intimateBillingAgreement when calling billingAgreementsIntimation'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling billingAgreementsIntimation"); throw new \InvalidArgumentException('Missing the required parameter $id when calling billingAgreementsIntimation'); } + // parse inputs $resourcePath = "/pts/v2/billing-agreements/{id}/intimations"; $httpBody = ''; @@ -383,6 +387,7 @@ public function billingAgreementsRegistrationWithHttpInfo($createBillingAgreemen self::$logger->error("InvalidArgumentException : Missing the required parameter $createBillingAgreement when calling billingAgreementsRegistration"); throw new \InvalidArgumentException('Missing the required parameter $createBillingAgreement when calling billingAgreementsRegistration'); } + // parse inputs $resourcePath = "/pts/v2/billing-agreements"; $httpBody = ''; diff --git a/lib/Api/CaptureApi.php b/lib/Api/CaptureApi.php index 8552e6652..09bd8482b 100644 --- a/lib/Api/CaptureApi.php +++ b/lib/Api/CaptureApi.php @@ -129,11 +129,13 @@ public function capturePaymentWithHttpInfo($capturePaymentRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $capturePaymentRequest when calling capturePayment"); throw new \InvalidArgumentException('Missing the required parameter $capturePaymentRequest when calling capturePayment'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling capturePayment"); throw new \InvalidArgumentException('Missing the required parameter $id when calling capturePayment'); } + // parse inputs $resourcePath = "/pts/v2/payments/{id}/captures"; $httpBody = ''; diff --git a/lib/Api/ChargebackDetailsApi.php b/lib/Api/ChargebackDetailsApi.php index 53ac47c1f..9d4bf3073 100644 --- a/lib/Api/ChargebackDetailsApi.php +++ b/lib/Api/ChargebackDetailsApi.php @@ -131,16 +131,14 @@ public function getChargebackDetailsWithHttpInfo($startTime, $endTime, $organiza self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getChargebackDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getChargebackDetails'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getChargebackDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getChargebackDetails'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ChargebackDetailsApi.getChargebackDetails, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ChargebackDetailsApi.getChargebackDetails, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/chargeback-details"; $httpBody = ''; diff --git a/lib/Api/ChargebackSummariesApi.php b/lib/Api/ChargebackSummariesApi.php index 5e327a29a..0fe6b4e81 100644 --- a/lib/Api/ChargebackSummariesApi.php +++ b/lib/Api/ChargebackSummariesApi.php @@ -131,16 +131,14 @@ public function getChargebackSummariesWithHttpInfo($startTime, $endTime, $organi self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getChargebackSummaries"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getChargebackSummaries'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getChargebackSummaries"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getChargebackSummaries'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ChargebackSummariesApi.getChargebackSummaries, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ChargebackSummariesApi.getChargebackSummaries, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/chargeback-summaries"; $httpBody = ''; diff --git a/lib/Api/ConversionDetailsApi.php b/lib/Api/ConversionDetailsApi.php index 94c5c500e..93fa89955 100644 --- a/lib/Api/ConversionDetailsApi.php +++ b/lib/Api/ConversionDetailsApi.php @@ -131,16 +131,14 @@ public function getConversionDetailWithHttpInfo($startTime, $endTime, $organizat self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getConversionDetail"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getConversionDetail'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getConversionDetail"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getConversionDetail'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ConversionDetailsApi.getConversionDetail, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ConversionDetailsApi.getConversionDetail, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/conversion-details"; $httpBody = ''; diff --git a/lib/Api/CreateNewWebhooksApi.php b/lib/Api/CreateNewWebhooksApi.php index 5744af857..32b8e9f96 100644 --- a/lib/Api/CreateNewWebhooksApi.php +++ b/lib/Api/CreateNewWebhooksApi.php @@ -124,6 +124,7 @@ public function createWebhookSubscription($createWebhookRequest = null) */ public function createWebhookSubscriptionWithHttpInfo($createWebhookRequest = null) { + // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks"; $httpBody = ''; @@ -231,6 +232,7 @@ public function findProductsToSubscribeWithHttpInfo($organizationId) self::$logger->error("InvalidArgumentException : Missing the required parameter $organizationId when calling findProductsToSubscribe"); throw new \InvalidArgumentException('Missing the required parameter $organizationId when calling findProductsToSubscribe'); } + // parse inputs $resourcePath = "/notification-subscriptions/v1/products/{organizationId}"; $httpBody = ''; @@ -345,21 +347,15 @@ public function saveSymEgressKeyWithHttpInfo($vCSenderOrganizationId, $vCPermiss self::$logger->error("InvalidArgumentException : Missing the required parameter $vCSenderOrganizationId when calling saveSymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $vCSenderOrganizationId when calling saveSymEgressKey'); } - if (!preg_match("/^[A-Za-z0-9\\-_]+$/", $vCSenderOrganizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"vCSenderOrganizationId\" when calling CreateNewWebhooksApi.saveSymEgressKey, must conform to the pattern /^[A-Za-z0-9\\-_]+$/."); - throw new \InvalidArgumentException('Invalid value for \"vCSenderOrganizationId\" when calling CreateNewWebhooksApi.saveSymEgressKey, must conform to the pattern /^[A-Za-z0-9\\-_]+$/.'); - } - + // verify the required parameter 'vCPermissions' is set if ($vCPermissions === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCPermissions when calling saveSymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $vCPermissions when calling saveSymEgressKey'); } - if (!is_null($vCCorrelationId) && !preg_match("/^[A-Za-z0-9\\.\\-_:]+$/", $vCCorrelationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"vCCorrelationId\" when calling CreateNewWebhooksApi.saveSymEgressKey, must conform to the pattern /^[A-Za-z0-9\\.\\-_:]+$/."); - throw new \InvalidArgumentException('Invalid value for \"vCCorrelationId\" when calling CreateNewWebhooksApi.saveSymEgressKey, must conform to the pattern /^[A-Za-z0-9\\.\\-_:]+$/.'); - } - + + + // parse inputs $resourcePath = "/kms/egress/v2/keys-sym"; $httpBody = ''; diff --git a/lib/Api/CreditApi.php b/lib/Api/CreditApi.php index 2cfe3cc2e..62cc46afc 100644 --- a/lib/Api/CreditApi.php +++ b/lib/Api/CreditApi.php @@ -127,6 +127,7 @@ public function createCreditWithHttpInfo($createCreditRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createCreditRequest when calling createCredit"); throw new \InvalidArgumentException('Missing the required parameter $createCreditRequest when calling createCredit'); } + // parse inputs $resourcePath = "/pts/v2/credits"; $httpBody = ''; diff --git a/lib/Api/CustomerApi.php b/lib/Api/CustomerApi.php index e65c31998..969552884 100644 --- a/lib/Api/CustomerApi.php +++ b/lib/Api/CustomerApi.php @@ -129,8 +129,8 @@ public function deleteCustomerWithHttpInfo($customerId, $profileId = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling deleteCustomer"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling deleteCustomer'); } - - + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}"; $httpBody = ''; @@ -263,8 +263,8 @@ public function getCustomerWithHttpInfo($customerId, $profileId = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomer"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomer'); } - - + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}"; $httpBody = ''; @@ -405,14 +405,15 @@ public function patchCustomerWithHttpInfo($customerId, $patchCustomerRequest, $p self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling patchCustomer"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling patchCustomer'); } - + // verify the required parameter 'patchCustomerRequest' is set if ($patchCustomerRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchCustomerRequest when calling patchCustomer"); throw new \InvalidArgumentException('Missing the required parameter $patchCustomerRequest when calling patchCustomer'); } - - + + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}"; $httpBody = ''; @@ -564,7 +565,8 @@ public function postCustomerWithHttpInfo($postCustomerRequest, $profileId = null self::$logger->error("InvalidArgumentException : Missing the required parameter $postCustomerRequest when calling postCustomer"); throw new \InvalidArgumentException('Missing the required parameter $postCustomerRequest when calling postCustomer'); } - + + // parse inputs $resourcePath = "/tms/v2/customers"; $httpBody = ''; diff --git a/lib/Api/CustomerPaymentInstrumentApi.php b/lib/Api/CustomerPaymentInstrumentApi.php index fc09fa1fa..dd23591b1 100644 --- a/lib/Api/CustomerPaymentInstrumentApi.php +++ b/lib/Api/CustomerPaymentInstrumentApi.php @@ -131,14 +131,14 @@ public function deleteCustomerPaymentInstrumentWithHttpInfo($customerId, $paymen self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling deleteCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling deleteCustomerPaymentInstrument'); } - + // verify the required parameter 'paymentInstrumentId' is set if ($paymentInstrumentId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling deleteCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling deleteCustomerPaymentInstrument'); } - - + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}"; $httpBody = ''; @@ -285,14 +285,14 @@ public function getCustomerPaymentInstrumentWithHttpInfo($customerId, $paymentIn self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomerPaymentInstrument'); } - + // verify the required parameter 'paymentInstrumentId' is set if ($paymentInstrumentId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling getCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling getCustomerPaymentInstrument'); } - - + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}"; $httpBody = ''; @@ -441,10 +441,10 @@ public function getCustomerPaymentInstrumentsListWithHttpInfo($customerId, $prof self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomerPaymentInstrumentsList"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomerPaymentInstrumentsList'); } - - - - + + + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments"; $httpBody = ''; @@ -597,20 +597,21 @@ public function patchCustomersPaymentInstrumentWithHttpInfo($customerId, $paymen self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling patchCustomersPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling patchCustomersPaymentInstrument'); } - + // verify the required parameter 'paymentInstrumentId' is set if ($paymentInstrumentId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling patchCustomersPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling patchCustomersPaymentInstrument'); } - + // verify the required parameter 'patchCustomerPaymentInstrumentRequest' is set if ($patchCustomerPaymentInstrumentRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchCustomerPaymentInstrumentRequest when calling patchCustomersPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $patchCustomerPaymentInstrumentRequest when calling patchCustomersPaymentInstrument'); } - - + + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}"; $httpBody = ''; @@ -772,13 +773,14 @@ public function postCustomerPaymentInstrumentWithHttpInfo($customerId, $postCust self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling postCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling postCustomerPaymentInstrument'); } - + // verify the required parameter 'postCustomerPaymentInstrumentRequest' is set if ($postCustomerPaymentInstrumentRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $postCustomerPaymentInstrumentRequest when calling postCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $postCustomerPaymentInstrumentRequest when calling postCustomerPaymentInstrument'); } - + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments"; $httpBody = ''; diff --git a/lib/Api/CustomerShippingAddressApi.php b/lib/Api/CustomerShippingAddressApi.php index 9422191d5..ef719fd31 100644 --- a/lib/Api/CustomerShippingAddressApi.php +++ b/lib/Api/CustomerShippingAddressApi.php @@ -131,14 +131,14 @@ public function deleteCustomerShippingAddressWithHttpInfo($customerId, $shipping self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling deleteCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling deleteCustomerShippingAddress'); } - + // verify the required parameter 'shippingAddressId' is set if ($shippingAddressId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $shippingAddressId when calling deleteCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $shippingAddressId when calling deleteCustomerShippingAddress'); } - - + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}"; $httpBody = ''; @@ -285,14 +285,14 @@ public function getCustomerShippingAddressWithHttpInfo($customerId, $shippingAdd self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomerShippingAddress'); } - + // verify the required parameter 'shippingAddressId' is set if ($shippingAddressId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $shippingAddressId when calling getCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $shippingAddressId when calling getCustomerShippingAddress'); } - - + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}"; $httpBody = ''; @@ -441,10 +441,10 @@ public function getCustomerShippingAddressesListWithHttpInfo($customerId, $profi self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomerShippingAddressesList"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomerShippingAddressesList'); } - - - - + + + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses"; $httpBody = ''; @@ -597,20 +597,21 @@ public function patchCustomersShippingAddressWithHttpInfo($customerId, $shipping self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling patchCustomersShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling patchCustomersShippingAddress'); } - + // verify the required parameter 'shippingAddressId' is set if ($shippingAddressId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $shippingAddressId when calling patchCustomersShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $shippingAddressId when calling patchCustomersShippingAddress'); } - + // verify the required parameter 'patchCustomerShippingAddressRequest' is set if ($patchCustomerShippingAddressRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchCustomerShippingAddressRequest when calling patchCustomersShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $patchCustomerShippingAddressRequest when calling patchCustomersShippingAddress'); } - - + + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}"; $httpBody = ''; @@ -772,13 +773,14 @@ public function postCustomerShippingAddressWithHttpInfo($customerId, $postCustom self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling postCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling postCustomerShippingAddress'); } - + // verify the required parameter 'postCustomerShippingAddressRequest' is set if ($postCustomerShippingAddressRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $postCustomerShippingAddressRequest when calling postCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $postCustomerShippingAddressRequest when calling postCustomerShippingAddress'); } - + + // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses"; $httpBody = ''; diff --git a/lib/Api/DecisionManagerApi.php b/lib/Api/DecisionManagerApi.php index 96f680948..98e9735b8 100644 --- a/lib/Api/DecisionManagerApi.php +++ b/lib/Api/DecisionManagerApi.php @@ -129,11 +129,13 @@ public function actionDecisionManagerCaseWithHttpInfo($id, $caseManagementAction self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling actionDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $id when calling actionDecisionManagerCase'); } + // verify the required parameter 'caseManagementActionsRequest' is set if ($caseManagementActionsRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $caseManagementActionsRequest when calling actionDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $caseManagementActionsRequest when calling actionDecisionManagerCase'); } + // parse inputs $resourcePath = "/risk/v1/decisions/{id}/actions"; $httpBody = ''; @@ -273,11 +275,13 @@ public function addNegativeWithHttpInfo($type, $addNegativeListRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $type when calling addNegative"); throw new \InvalidArgumentException('Missing the required parameter $type when calling addNegative'); } + // verify the required parameter 'addNegativeListRequest' is set if ($addNegativeListRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $addNegativeListRequest when calling addNegative"); throw new \InvalidArgumentException('Missing the required parameter $addNegativeListRequest when calling addNegative'); } + // parse inputs $resourcePath = "/risk/v1/lists/{type}/entries"; $httpBody = ''; @@ -397,11 +401,13 @@ public function commentDecisionManagerCaseWithHttpInfo($id, $caseManagementComme self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling commentDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $id when calling commentDecisionManagerCase'); } + // verify the required parameter 'caseManagementCommentsRequest' is set if ($caseManagementCommentsRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $caseManagementCommentsRequest when calling commentDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $caseManagementCommentsRequest when calling commentDecisionManagerCase'); } + // parse inputs $resourcePath = "/risk/v1/decisions/{id}/comments"; $httpBody = ''; @@ -539,6 +545,7 @@ public function createBundledDecisionManagerCaseWithHttpInfo($createBundledDecis self::$logger->error("InvalidArgumentException : Missing the required parameter $createBundledDecisionManagerCaseRequest when calling createBundledDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $createBundledDecisionManagerCaseRequest when calling createBundledDecisionManagerCase'); } + // parse inputs $resourcePath = "/risk/v1/decisions"; $httpBody = ''; @@ -654,11 +661,13 @@ public function fraudUpdateWithHttpInfo($id, $fraudMarkingActionRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling fraudUpdate"); throw new \InvalidArgumentException('Missing the required parameter $id when calling fraudUpdate'); } + // verify the required parameter 'fraudMarkingActionRequest' is set if ($fraudMarkingActionRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $fraudMarkingActionRequest when calling fraudUpdate"); throw new \InvalidArgumentException('Missing the required parameter $fraudMarkingActionRequest when calling fraudUpdate'); } + // parse inputs $resourcePath = "/risk/v1/decisions/{id}/marking"; $httpBody = ''; diff --git a/lib/Api/DownloadDTDApi.php b/lib/Api/DownloadDTDApi.php index 9dbc4a763..84257e558 100644 --- a/lib/Api/DownloadDTDApi.php +++ b/lib/Api/DownloadDTDApi.php @@ -127,6 +127,7 @@ public function getDTDV2WithHttpInfo($reportDefinitionNameVersion) self::$logger->error("InvalidArgumentException : Missing the required parameter $reportDefinitionNameVersion when calling getDTDV2"); throw new \InvalidArgumentException('Missing the required parameter $reportDefinitionNameVersion when calling getDTDV2'); } + // parse inputs $resourcePath = "/reporting/v3/dtds/{reportDefinitionNameVersion}"; $httpBody = ''; diff --git a/lib/Api/DownloadXSDApi.php b/lib/Api/DownloadXSDApi.php index b3e757be4..a24c51872 100644 --- a/lib/Api/DownloadXSDApi.php +++ b/lib/Api/DownloadXSDApi.php @@ -127,6 +127,7 @@ public function getXSDV2WithHttpInfo($reportDefinitionNameVersion) self::$logger->error("InvalidArgumentException : Missing the required parameter $reportDefinitionNameVersion when calling getXSDV2"); throw new \InvalidArgumentException('Missing the required parameter $reportDefinitionNameVersion when calling getXSDV2'); } + // parse inputs $resourcePath = "/reporting/v3/xsds/{reportDefinitionNameVersion}"; $httpBody = ''; diff --git a/lib/Api/EMVTagDetailsApi.php b/lib/Api/EMVTagDetailsApi.php index bf749bbfc..e19008200 100644 --- a/lib/Api/EMVTagDetailsApi.php +++ b/lib/Api/EMVTagDetailsApi.php @@ -218,6 +218,7 @@ public function parseEmvTagsWithHttpInfo($body) self::$logger->error("InvalidArgumentException : Missing the required parameter $body when calling parseEmvTags"); throw new \InvalidArgumentException('Missing the required parameter $body when calling parseEmvTags'); } + // parse inputs $resourcePath = "/tss/v2/transactions/emvTagDetails"; $httpBody = ''; diff --git a/lib/Api/InstrumentIdentifierApi.php b/lib/Api/InstrumentIdentifierApi.php index b48e575bf..f31acef90 100644 --- a/lib/Api/InstrumentIdentifierApi.php +++ b/lib/Api/InstrumentIdentifierApi.php @@ -129,8 +129,8 @@ public function deleteInstrumentIdentifierWithHttpInfo($instrumentIdentifierId, self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling deleteInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling deleteInstrumentIdentifier'); } - - + + // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}"; $httpBody = ''; @@ -263,8 +263,8 @@ public function getInstrumentIdentifierWithHttpInfo($instrumentIdentifierId, $pr self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling getInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling getInstrumentIdentifier'); } - - + + // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}"; $httpBody = ''; @@ -405,10 +405,10 @@ public function getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo($instr self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling getInstrumentIdentifierPaymentInstrumentsList"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling getInstrumentIdentifierPaymentInstrumentsList'); } - - - - + + + + // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}/paymentinstruments"; $httpBody = ''; @@ -559,14 +559,15 @@ public function patchInstrumentIdentifierWithHttpInfo($instrumentIdentifierId, $ self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling patchInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling patchInstrumentIdentifier'); } - + // verify the required parameter 'patchInstrumentIdentifierRequest' is set if ($patchInstrumentIdentifierRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchInstrumentIdentifierRequest when calling patchInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $patchInstrumentIdentifierRequest when calling patchInstrumentIdentifier'); } - - + + + // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}"; $httpBody = ''; @@ -718,7 +719,8 @@ public function postInstrumentIdentifierWithHttpInfo($postInstrumentIdentifierRe self::$logger->error("InvalidArgumentException : Missing the required parameter $postInstrumentIdentifierRequest when calling postInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $postInstrumentIdentifierRequest when calling postInstrumentIdentifier'); } - + + // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers"; $httpBody = ''; @@ -856,13 +858,14 @@ public function postInstrumentIdentifierEnrollmentWithHttpInfo($instrumentIdenti self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling postInstrumentIdentifierEnrollment"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling postInstrumentIdentifierEnrollment'); } - + // verify the required parameter 'postInstrumentIdentifierEnrollmentRequest' is set if ($postInstrumentIdentifierEnrollmentRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $postInstrumentIdentifierEnrollmentRequest when calling postInstrumentIdentifierEnrollment"); throw new \InvalidArgumentException('Missing the required parameter $postInstrumentIdentifierEnrollmentRequest when calling postInstrumentIdentifierEnrollment'); } - + + // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}/enrollment"; $httpBody = ''; diff --git a/lib/Api/InterchangeClearingLevelDetailsApi.php b/lib/Api/InterchangeClearingLevelDetailsApi.php index c58fe0329..a2744e2f4 100644 --- a/lib/Api/InterchangeClearingLevelDetailsApi.php +++ b/lib/Api/InterchangeClearingLevelDetailsApi.php @@ -131,16 +131,14 @@ public function getInterchangeClearingLevelDetailsWithHttpInfo($startTime, $endT self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getInterchangeClearingLevelDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getInterchangeClearingLevelDetails'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getInterchangeClearingLevelDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getInterchangeClearingLevelDetails'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling InterchangeClearingLevelDetailsApi.getInterchangeClearingLevelDetails, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling InterchangeClearingLevelDetailsApi.getInterchangeClearingLevelDetails, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/interchange-clearing-level-details"; $httpBody = ''; diff --git a/lib/Api/InvoiceSettingsApi.php b/lib/Api/InvoiceSettingsApi.php index a8b049ffe..ccbe288cc 100644 --- a/lib/Api/InvoiceSettingsApi.php +++ b/lib/Api/InvoiceSettingsApi.php @@ -226,6 +226,7 @@ public function updateInvoiceSettingsWithHttpInfo($invoiceSettingsRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $invoiceSettingsRequest when calling updateInvoiceSettings"); throw new \InvalidArgumentException('Missing the required parameter $invoiceSettingsRequest when calling updateInvoiceSettings'); } + // parse inputs $resourcePath = "/invoicing/v2/invoiceSettings"; $httpBody = ''; diff --git a/lib/Api/InvoicesApi.php b/lib/Api/InvoicesApi.php index 4f8ce0a36..cab4c0ead 100644 --- a/lib/Api/InvoicesApi.php +++ b/lib/Api/InvoicesApi.php @@ -127,6 +127,7 @@ public function createInvoiceWithHttpInfo($createInvoiceRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createInvoiceRequest when calling createInvoice"); throw new \InvalidArgumentException('Missing the required parameter $createInvoiceRequest when calling createInvoice'); } + // parse inputs $resourcePath = "/invoicing/v2/invoices"; $httpBody = ''; @@ -252,11 +253,14 @@ public function getAllInvoicesWithHttpInfo($offset, $limit, $status = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $offset when calling getAllInvoices"); throw new \InvalidArgumentException('Missing the required parameter $offset when calling getAllInvoices'); } + // verify the required parameter 'limit' is set if ($limit === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $limit when calling getAllInvoices"); throw new \InvalidArgumentException('Missing the required parameter $limit when calling getAllInvoices'); } + + // parse inputs $resourcePath = "/invoicing/v2/invoices"; $httpBody = ''; @@ -382,6 +386,7 @@ public function getInvoiceWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getInvoice"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getInvoice'); } + // parse inputs $resourcePath = "/invoicing/v2/invoices/{id}"; $httpBody = ''; @@ -500,6 +505,7 @@ public function performCancelActionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling performCancelAction"); throw new \InvalidArgumentException('Missing the required parameter $id when calling performCancelAction'); } + // parse inputs $resourcePath = "/invoicing/v2/invoices/{id}/cancelation"; $httpBody = ''; @@ -618,6 +624,7 @@ public function performSendActionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling performSendAction"); throw new \InvalidArgumentException('Missing the required parameter $id when calling performSendAction'); } + // parse inputs $resourcePath = "/invoicing/v2/invoices/{id}/delivery"; $httpBody = ''; @@ -738,11 +745,13 @@ public function updateInvoiceWithHttpInfo($id, $updateInvoiceRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling updateInvoice"); throw new \InvalidArgumentException('Missing the required parameter $id when calling updateInvoice'); } + // verify the required parameter 'updateInvoiceRequest' is set if ($updateInvoiceRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updateInvoiceRequest when calling updateInvoice"); throw new \InvalidArgumentException('Missing the required parameter $updateInvoiceRequest when calling updateInvoice'); } + // parse inputs $resourcePath = "/invoicing/v2/invoices/{id}"; $httpBody = ''; diff --git a/lib/Api/KeymanagementApi.php b/lib/Api/KeymanagementApi.php index 239c3d1f1..b37f16e90 100644 --- a/lib/Api/KeymanagementApi.php +++ b/lib/Api/KeymanagementApi.php @@ -136,16 +136,14 @@ public function searchKeys($offset = null, $limit = null, $sort = null, $organiz */ public function searchKeysWithHttpInfo($offset = null, $limit = null, $sort = null, $organizationIds = null, $keyIds = null, $keyTypes = null, $expirationStartDate = null, $expirationEndDate = null) { - if (!is_null($expirationStartDate) && !preg_match("/yyyy-mm-dd/", $expirationStartDate)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"expirationStartDate\" when calling KeyManagementApi.searchKeys, must conform to the pattern /yyyy-mm-dd/."); - throw new \InvalidArgumentException('Invalid value for \"expirationStartDate\" when calling KeyManagementApi.searchKeys, must conform to the pattern /yyyy-mm-dd/.'); - } - - if (!is_null($expirationEndDate) && !preg_match("/yyyy-mm-dd/", $expirationEndDate)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"expirationEndDate\" when calling KeyManagementApi.searchKeys, must conform to the pattern /yyyy-mm-dd/."); - throw new \InvalidArgumentException('Invalid value for \"expirationEndDate\" when calling KeyManagementApi.searchKeys, must conform to the pattern /yyyy-mm-dd/.'); - } - + + + + + + + + // parse inputs $resourcePath = "/kms/v2/keys"; $httpBody = ''; diff --git a/lib/Api/KeymanagementpasswordApi.php b/lib/Api/KeymanagementpasswordApi.php index ec3808a29..f807505d6 100644 --- a/lib/Api/KeymanagementpasswordApi.php +++ b/lib/Api/KeymanagementpasswordApi.php @@ -129,11 +129,13 @@ public function updatePasswordWithHttpInfo($keyId, $updatePasswordKeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling updatePassword"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling updatePassword'); } + // verify the required parameter 'updatePasswordKeysRequest' is set if ($updatePasswordKeysRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updatePasswordKeysRequest when calling updatePassword"); throw new \InvalidArgumentException('Missing the required parameter $updatePasswordKeysRequest when calling updatePassword'); } + // parse inputs $resourcePath = "/kms/v2/keys-password/{keyId}"; $httpBody = ''; diff --git a/lib/Api/KeymanagementpgpApi.php b/lib/Api/KeymanagementpgpApi.php index 1341c6cc2..485f0404c 100644 --- a/lib/Api/KeymanagementpgpApi.php +++ b/lib/Api/KeymanagementpgpApi.php @@ -129,11 +129,13 @@ public function updatePGPWithHttpInfo($keyId, $updatePGPKeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling updatePGP"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling updatePGP'); } + // verify the required parameter 'updatePGPKeysRequest' is set if ($updatePGPKeysRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updatePGPKeysRequest when calling updatePGP"); throw new \InvalidArgumentException('Missing the required parameter $updatePGPKeysRequest when calling updatePGP'); } + // parse inputs $resourcePath = "/kms/v2/keys-pgp/{keyId}"; $httpBody = ''; diff --git a/lib/Api/KeymanagementscmpApi.php b/lib/Api/KeymanagementscmpApi.php index 447e1316a..02134bf41 100644 --- a/lib/Api/KeymanagementscmpApi.php +++ b/lib/Api/KeymanagementscmpApi.php @@ -129,11 +129,13 @@ public function updateSCMPWithHttpInfo($keyId, $updatePGPKeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling updateSCMP"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling updateSCMP'); } + // verify the required parameter 'updatePGPKeysRequest' is set if ($updatePGPKeysRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updatePGPKeysRequest when calling updateSCMP"); throw new \InvalidArgumentException('Missing the required parameter $updatePGPKeysRequest when calling updateSCMP'); } + // parse inputs $resourcePath = "/kms/v2/keys-scmp/{keyId}"; $httpBody = ''; diff --git a/lib/Api/ManageWebhooksApi.php b/lib/Api/ManageWebhooksApi.php index c16d7c5dc..78aae9f35 100644 --- a/lib/Api/ManageWebhooksApi.php +++ b/lib/Api/ManageWebhooksApi.php @@ -129,6 +129,7 @@ public function deleteWebhookSubscriptionWithHttpInfo($webhookId) self::$logger->error("InvalidArgumentException : Missing the required parameter $webhookId when calling deleteWebhookSubscription"); throw new \InvalidArgumentException('Missing the required parameter $webhookId when calling deleteWebhookSubscription'); } + // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks/{webhookId}"; $httpBody = ''; @@ -233,6 +234,7 @@ public function getWebhookSubscriptionByIdWithHttpInfo($webhookId) self::$logger->error("InvalidArgumentException : Missing the required parameter $webhookId when calling getWebhookSubscriptionById"); throw new \InvalidArgumentException('Missing the required parameter $webhookId when calling getWebhookSubscriptionById'); } + // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks/{webhookId}"; $httpBody = ''; @@ -345,16 +347,19 @@ public function getWebhookSubscriptionsByOrgWithHttpInfo($organizationId, $produ self::$logger->error("InvalidArgumentException : Missing the required parameter $organizationId when calling getWebhookSubscriptionsByOrg"); throw new \InvalidArgumentException('Missing the required parameter $organizationId when calling getWebhookSubscriptionsByOrg'); } + // verify the required parameter 'productId' is set if ($productId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $productId when calling getWebhookSubscriptionsByOrg"); throw new \InvalidArgumentException('Missing the required parameter $productId when calling getWebhookSubscriptionsByOrg'); } + // verify the required parameter 'eventType' is set if ($eventType === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $eventType when calling getWebhookSubscriptionsByOrg"); throw new \InvalidArgumentException('Missing the required parameter $eventType when calling getWebhookSubscriptionsByOrg'); } + // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks"; $httpBody = ''; @@ -476,26 +481,20 @@ public function saveAsymEgressKeyWithHttpInfo($vCSenderOrganizationId, $vCPermis self::$logger->error("InvalidArgumentException : Missing the required parameter $vCSenderOrganizationId when calling saveAsymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $vCSenderOrganizationId when calling saveAsymEgressKey'); } - if (!preg_match("/^[A-Za-z0-9\\-_]+$/", $vCSenderOrganizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"vCSenderOrganizationId\" when calling ManageWebhooksApi.saveAsymEgressKey, must conform to the pattern /^[A-Za-z0-9\\-_]+$/."); - throw new \InvalidArgumentException('Invalid value for \"vCSenderOrganizationId\" when calling ManageWebhooksApi.saveAsymEgressKey, must conform to the pattern /^[A-Za-z0-9\\-_]+$/.'); - } - + // verify the required parameter 'vCPermissions' is set if ($vCPermissions === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCPermissions when calling saveAsymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $vCPermissions when calling saveAsymEgressKey'); } + // verify the required parameter 'saveAsymEgressKey' is set if ($saveAsymEgressKey === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $saveAsymEgressKey when calling saveAsymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $saveAsymEgressKey when calling saveAsymEgressKey'); } - if (!is_null($vCCorrelationId) && !preg_match("/^[A-Za-z0-9\\.\\-_:]+$/", $vCCorrelationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"vCCorrelationId\" when calling ManageWebhooksApi.saveAsymEgressKey, must conform to the pattern /^[A-Za-z0-9\\.\\-_:]+$/."); - throw new \InvalidArgumentException('Invalid value for \"vCCorrelationId\" when calling ManageWebhooksApi.saveAsymEgressKey, must conform to the pattern /^[A-Za-z0-9\\.\\-_:]+$/.'); - } - + + // parse inputs $resourcePath = "/kms/egress/v2/keys-asym"; $httpBody = ''; @@ -617,6 +616,8 @@ public function updateWebhookSubscriptionWithHttpInfo($webhookId, $updateWebhook self::$logger->error("InvalidArgumentException : Missing the required parameter $webhookId when calling updateWebhookSubscription"); throw new \InvalidArgumentException('Missing the required parameter $webhookId when calling updateWebhookSubscription'); } + + // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks/{webhookId}"; $httpBody = ''; diff --git a/lib/Api/MerchantBoardingApi.php b/lib/Api/MerchantBoardingApi.php index 8ccbd3f5e..c0aa8e60a 100644 --- a/lib/Api/MerchantBoardingApi.php +++ b/lib/Api/MerchantBoardingApi.php @@ -129,6 +129,7 @@ public function getRegistrationWithHttpInfo($registrationId) self::$logger->error("InvalidArgumentException : Missing the required parameter $registrationId when calling getRegistration"); throw new \InvalidArgumentException('Missing the required parameter $registrationId when calling getRegistration'); } + // parse inputs $resourcePath = "/boarding/v1/registrations/{registrationId}"; $httpBody = ''; @@ -251,6 +252,8 @@ public function postRegistrationWithHttpInfo($postRegistrationBody, $vCIdempoten self::$logger->error("InvalidArgumentException : Missing the required parameter $postRegistrationBody when calling postRegistration"); throw new \InvalidArgumentException('Missing the required parameter $postRegistrationBody when calling postRegistration'); } + + // parse inputs $resourcePath = "/boarding/v1/registrations"; $httpBody = ''; diff --git a/lib/Api/MicroformIntegrationApi.php b/lib/Api/MicroformIntegrationApi.php index ae8182032..28b1f652e 100644 --- a/lib/Api/MicroformIntegrationApi.php +++ b/lib/Api/MicroformIntegrationApi.php @@ -127,6 +127,7 @@ public function generateCaptureContextWithHttpInfo($generateCaptureContextReques self::$logger->error("InvalidArgumentException : Missing the required parameter $generateCaptureContextRequest when calling generateCaptureContext"); throw new \InvalidArgumentException('Missing the required parameter $generateCaptureContextRequest when calling generateCaptureContext'); } + // parse inputs $resourcePath = "/microform/v2/sessions"; $httpBody = ''; diff --git a/lib/Api/NetFundingsApi.php b/lib/Api/NetFundingsApi.php index f1d43f1a0..4915547ec 100644 --- a/lib/Api/NetFundingsApi.php +++ b/lib/Api/NetFundingsApi.php @@ -133,16 +133,15 @@ public function getNetFundingDetailsWithHttpInfo($startTime, $endTime, $organiza self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getNetFundingDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getNetFundingDetails'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getNetFundingDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getNetFundingDetails'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling NetFundingsApi.getNetFundingDetails, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling NetFundingsApi.getNetFundingDetails, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + + // parse inputs $resourcePath = "/reporting/v3/net-fundings"; $httpBody = ''; diff --git a/lib/Api/NotificationOfChangesApi.php b/lib/Api/NotificationOfChangesApi.php index 1855e39a5..5fdb3443c 100644 --- a/lib/Api/NotificationOfChangesApi.php +++ b/lib/Api/NotificationOfChangesApi.php @@ -129,11 +129,13 @@ public function getNotificationOfChangeReportWithHttpInfo($startTime, $endTime) self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getNotificationOfChangeReport"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getNotificationOfChangeReport'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getNotificationOfChangeReport"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getNotificationOfChangeReport'); } + // parse inputs $resourcePath = "/reporting/v3/notification-of-changes"; $httpBody = ''; diff --git a/lib/Api/PayerAuthenticationApi.php b/lib/Api/PayerAuthenticationApi.php index dcb153fce..10c36c063 100644 --- a/lib/Api/PayerAuthenticationApi.php +++ b/lib/Api/PayerAuthenticationApi.php @@ -127,6 +127,7 @@ public function checkPayerAuthEnrollmentWithHttpInfo($checkPayerAuthEnrollmentRe self::$logger->error("InvalidArgumentException : Missing the required parameter $checkPayerAuthEnrollmentRequest when calling checkPayerAuthEnrollment"); throw new \InvalidArgumentException('Missing the required parameter $checkPayerAuthEnrollmentRequest when calling checkPayerAuthEnrollment'); } + // parse inputs $resourcePath = "/risk/v1/authentications"; $httpBody = ''; @@ -240,6 +241,7 @@ public function payerAuthSetupWithHttpInfo($payerAuthSetupRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $payerAuthSetupRequest when calling payerAuthSetup"); throw new \InvalidArgumentException('Missing the required parameter $payerAuthSetupRequest when calling payerAuthSetup'); } + // parse inputs $resourcePath = "/risk/v1/authentication-setups"; $httpBody = ''; @@ -353,6 +355,7 @@ public function validateAuthenticationResultsWithHttpInfo($validateRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $validateRequest when calling validateAuthenticationResults"); throw new \InvalidArgumentException('Missing the required parameter $validateRequest when calling validateAuthenticationResults'); } + // parse inputs $resourcePath = "/risk/v1/authentication-results"; $httpBody = ''; diff --git a/lib/Api/PaymentBatchSummariesApi.php b/lib/Api/PaymentBatchSummariesApi.php index 380f6258f..7f492bdba 100644 --- a/lib/Api/PaymentBatchSummariesApi.php +++ b/lib/Api/PaymentBatchSummariesApi.php @@ -137,17 +137,17 @@ public function getPaymentBatchSummaryWithHttpInfo($startTime, $endTime, $organi self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getPaymentBatchSummary"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getPaymentBatchSummary'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getPaymentBatchSummary"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getPaymentBatchSummary'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling PaymentBatchSummariesApi.getPaymentBatchSummary, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling PaymentBatchSummariesApi.getPaymentBatchSummary, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - - + + + + + // parse inputs $resourcePath = "/reporting/v3/payment-batch-summaries"; $httpBody = ''; diff --git a/lib/Api/PaymentInstrumentApi.php b/lib/Api/PaymentInstrumentApi.php index f6f4e2736..25396ac96 100644 --- a/lib/Api/PaymentInstrumentApi.php +++ b/lib/Api/PaymentInstrumentApi.php @@ -129,8 +129,8 @@ public function deletePaymentInstrumentWithHttpInfo($paymentInstrumentId, $profi self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling deletePaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling deletePaymentInstrument'); } - - + + // parse inputs $resourcePath = "/tms/v1/paymentinstruments/{paymentInstrumentId}"; $httpBody = ''; @@ -259,8 +259,8 @@ public function getPaymentInstrumentWithHttpInfo($paymentInstrumentId, $profileI self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling getPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling getPaymentInstrument'); } - - + + // parse inputs $resourcePath = "/tms/v1/paymentinstruments/{paymentInstrumentId}"; $httpBody = ''; @@ -401,14 +401,15 @@ public function patchPaymentInstrumentWithHttpInfo($paymentInstrumentId, $patchP self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling patchPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling patchPaymentInstrument'); } - + // verify the required parameter 'patchPaymentInstrumentRequest' is set if ($patchPaymentInstrumentRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchPaymentInstrumentRequest when calling patchPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $patchPaymentInstrumentRequest when calling patchPaymentInstrument'); } - - + + + // parse inputs $resourcePath = "/tms/v1/paymentinstruments/{paymentInstrumentId}"; $httpBody = ''; @@ -560,7 +561,8 @@ public function postPaymentInstrumentWithHttpInfo($postPaymentInstrumentRequest, self::$logger->error("InvalidArgumentException : Missing the required parameter $postPaymentInstrumentRequest when calling postPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $postPaymentInstrumentRequest when calling postPaymentInstrument'); } - + + // parse inputs $resourcePath = "/tms/v1/paymentinstruments"; $httpBody = ''; diff --git a/lib/Api/PaymentsApi.php b/lib/Api/PaymentsApi.php index 60d9c6d1d..b6562c659 100644 --- a/lib/Api/PaymentsApi.php +++ b/lib/Api/PaymentsApi.php @@ -129,11 +129,13 @@ public function createOrderRequestWithHttpInfo($orderPaymentRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $orderPaymentRequest when calling createOrderRequest"); throw new \InvalidArgumentException('Missing the required parameter $orderPaymentRequest when calling createOrderRequest'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling createOrderRequest"); throw new \InvalidArgumentException('Missing the required parameter $id when calling createOrderRequest'); } + // parse inputs $resourcePath = "/pts/v2/payment-references/{id}/intents"; $httpBody = ''; @@ -255,6 +257,7 @@ public function createPaymentWithHttpInfo($createPaymentRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createPaymentRequest when calling createPayment"); throw new \InvalidArgumentException('Missing the required parameter $createPaymentRequest when calling createPayment'); } + // parse inputs $resourcePath = "/pts/v2/payments"; $httpBody = ''; @@ -368,6 +371,7 @@ public function createSessionRequestWithHttpInfo($createSessionReq) self::$logger->error("InvalidArgumentException : Missing the required parameter $createSessionReq when calling createSessionRequest"); throw new \InvalidArgumentException('Missing the required parameter $createSessionReq when calling createSessionRequest'); } + // parse inputs $resourcePath = "/pts/v2/payment-references"; $httpBody = ''; @@ -483,11 +487,13 @@ public function incrementAuthWithHttpInfo($id, $incrementAuthRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling incrementAuth"); throw new \InvalidArgumentException('Missing the required parameter $id when calling incrementAuth'); } + // verify the required parameter 'incrementAuthRequest' is set if ($incrementAuthRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $incrementAuthRequest when calling incrementAuth"); throw new \InvalidArgumentException('Missing the required parameter $incrementAuthRequest when calling incrementAuth'); } + // parse inputs $resourcePath = "/pts/v2/payments/{id}"; $httpBody = ''; @@ -611,11 +617,13 @@ public function refreshPaymentStatusWithHttpInfo($id, $refreshPaymentStatusReque self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling refreshPaymentStatus"); throw new \InvalidArgumentException('Missing the required parameter $id when calling refreshPaymentStatus'); } + // verify the required parameter 'refreshPaymentStatusRequest' is set if ($refreshPaymentStatusRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $refreshPaymentStatusRequest when calling refreshPaymentStatus"); throw new \InvalidArgumentException('Missing the required parameter $refreshPaymentStatusRequest when calling refreshPaymentStatus'); } + // parse inputs $resourcePath = "/pts/v2/refresh-payment-status/{id}"; $httpBody = ''; @@ -739,11 +747,13 @@ public function updateSessionReqWithHttpInfo($createSessionRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $createSessionRequest when calling updateSessionReq"); throw new \InvalidArgumentException('Missing the required parameter $createSessionRequest when calling updateSessionReq'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling updateSessionReq"); throw new \InvalidArgumentException('Missing the required parameter $id when calling updateSessionReq'); } + // parse inputs $resourcePath = "/pts/v2/payment-references/{id}"; $httpBody = ''; diff --git a/lib/Api/PayoutsApi.php b/lib/Api/PayoutsApi.php index 1a1d4cfda..8327765ce 100644 --- a/lib/Api/PayoutsApi.php +++ b/lib/Api/PayoutsApi.php @@ -127,6 +127,7 @@ public function octCreatePaymentWithHttpInfo($octCreatePaymentRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $octCreatePaymentRequest when calling octCreatePayment"); throw new \InvalidArgumentException('Missing the required parameter $octCreatePaymentRequest when calling octCreatePayment'); } + // parse inputs $resourcePath = "/pts/v2/payouts"; $httpBody = ''; diff --git a/lib/Api/PlansApi.php b/lib/Api/PlansApi.php index 0d9557827..fd92d2483 100644 --- a/lib/Api/PlansApi.php +++ b/lib/Api/PlansApi.php @@ -127,6 +127,7 @@ public function activatePlanWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling activatePlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling activatePlan'); } + // parse inputs $resourcePath = "/rbs/v1/plans/{id}/activate"; $httpBody = ''; @@ -245,6 +246,7 @@ public function createPlanWithHttpInfo($createPlanRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createPlanRequest when calling createPlan"); throw new \InvalidArgumentException('Missing the required parameter $createPlanRequest when calling createPlan'); } + // parse inputs $resourcePath = "/rbs/v1/plans"; $httpBody = ''; @@ -358,6 +360,7 @@ public function deactivatePlanWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling deactivatePlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling deactivatePlan'); } + // parse inputs $resourcePath = "/rbs/v1/plans/{id}/deactivate"; $httpBody = ''; @@ -476,6 +479,7 @@ public function deletePlanWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling deletePlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling deletePlan'); } + // parse inputs $resourcePath = "/rbs/v1/plans/{id}"; $httpBody = ''; @@ -594,6 +598,7 @@ public function getPlanWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getPlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getPlan'); } + // parse inputs $resourcePath = "/rbs/v1/plans/{id}"; $httpBody = ''; @@ -814,6 +819,11 @@ public function getPlans($offset = null, $limit = null, $code = null, $status = */ public function getPlansWithHttpInfo($offset = null, $limit = null, $code = null, $status = null, $name = null) { + + + + + // parse inputs $resourcePath = "/rbs/v1/plans"; $httpBody = ''; @@ -947,11 +957,13 @@ public function updatePlanWithHttpInfo($id, $updatePlanRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling updatePlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling updatePlan'); } + // verify the required parameter 'updatePlanRequest' is set if ($updatePlanRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updatePlanRequest when calling updatePlan"); throw new \InvalidArgumentException('Missing the required parameter $updatePlanRequest when calling updatePlan'); } + // parse inputs $resourcePath = "/rbs/v1/plans/{id}"; $httpBody = ''; diff --git a/lib/Api/PurchaseAndRefundDetailsApi.php b/lib/Api/PurchaseAndRefundDetailsApi.php index ff031f89a..344652f88 100644 --- a/lib/Api/PurchaseAndRefundDetailsApi.php +++ b/lib/Api/PurchaseAndRefundDetailsApi.php @@ -141,17 +141,19 @@ public function getPurchaseAndRefundDetailsWithHttpInfo($startTime, $endTime, $o self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getPurchaseAndRefundDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getPurchaseAndRefundDetails'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getPurchaseAndRefundDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getPurchaseAndRefundDetails'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling PurchaseAndRefundDetailsApi.getPurchaseAndRefundDetails, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling PurchaseAndRefundDetailsApi.getPurchaseAndRefundDetails, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - - + + + + + + + // parse inputs $resourcePath = "/reporting/v3/purchase-refund-details"; $httpBody = ''; diff --git a/lib/Api/PushFundsApi.php b/lib/Api/PushFundsApi.php index 0efb5449d..a6cd2bc3f 100644 --- a/lib/Api/PushFundsApi.php +++ b/lib/Api/PushFundsApi.php @@ -139,36 +139,43 @@ public function createPushFundsTransferWithHttpInfo($pushFundsRequest, $contentT self::$logger->error("InvalidArgumentException : Missing the required parameter $pushFundsRequest when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $pushFundsRequest when calling createPushFundsTransfer'); } + // verify the required parameter 'contentType' is set if ($contentType === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $contentType when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $contentType when calling createPushFundsTransfer'); } + // verify the required parameter 'xRequestid' is set if ($xRequestid === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $xRequestid when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $xRequestid when calling createPushFundsTransfer'); } + // verify the required parameter 'vCMerchantId' is set if ($vCMerchantId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCMerchantId when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $vCMerchantId when calling createPushFundsTransfer'); } + // verify the required parameter 'vCPermissions' is set if ($vCPermissions === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCPermissions when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $vCPermissions when calling createPushFundsTransfer'); } + // verify the required parameter 'vCCorrelationId' is set if ($vCCorrelationId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCCorrelationId when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $vCCorrelationId when calling createPushFundsTransfer'); } + // verify the required parameter 'vCOrganizationId' is set if ($vCOrganizationId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCOrganizationId when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $vCOrganizationId when calling createPushFundsTransfer'); } + // parse inputs $resourcePath = "/pts/v1/push-funds-transfer"; $httpBody = ''; diff --git a/lib/Api/RefundApi.php b/lib/Api/RefundApi.php index 3ddd5162b..25e431556 100644 --- a/lib/Api/RefundApi.php +++ b/lib/Api/RefundApi.php @@ -129,11 +129,13 @@ public function refundCaptureWithHttpInfo($refundCaptureRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $refundCaptureRequest when calling refundCapture"); throw new \InvalidArgumentException('Missing the required parameter $refundCaptureRequest when calling refundCapture'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling refundCapture"); throw new \InvalidArgumentException('Missing the required parameter $id when calling refundCapture'); } + // parse inputs $resourcePath = "/pts/v2/captures/{id}/refunds"; $httpBody = ''; @@ -257,11 +259,13 @@ public function refundPaymentWithHttpInfo($refundPaymentRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $refundPaymentRequest when calling refundPayment"); throw new \InvalidArgumentException('Missing the required parameter $refundPaymentRequest when calling refundPayment'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling refundPayment"); throw new \InvalidArgumentException('Missing the required parameter $id when calling refundPayment'); } + // parse inputs $resourcePath = "/pts/v2/payments/{id}/refunds"; $httpBody = ''; diff --git a/lib/Api/ReplayWebhooksApi.php b/lib/Api/ReplayWebhooksApi.php index 955753d5d..b8ca3b472 100644 --- a/lib/Api/ReplayWebhooksApi.php +++ b/lib/Api/ReplayWebhooksApi.php @@ -131,6 +131,8 @@ public function replayPreviousWebhooksWithHttpInfo($webhookId, $replayWebhooksRe self::$logger->error("InvalidArgumentException : Missing the required parameter $webhookId when calling replayPreviousWebhooks"); throw new \InvalidArgumentException('Missing the required parameter $webhookId when calling replayPreviousWebhooks'); } + + // parse inputs $resourcePath = "/nrtf/v1/webhooks/{webhookId}/replays"; $httpBody = ''; diff --git a/lib/Api/ReportDefinitionsApi.php b/lib/Api/ReportDefinitionsApi.php index f2e712ead..baf845296 100644 --- a/lib/Api/ReportDefinitionsApi.php +++ b/lib/Api/ReportDefinitionsApi.php @@ -133,11 +133,10 @@ public function getResourceInfoByReportDefinitionWithHttpInfo($reportDefinitionN self::$logger->error("InvalidArgumentException : Missing the required parameter $reportDefinitionName when calling getResourceInfoByReportDefinition"); throw new \InvalidArgumentException('Missing the required parameter $reportDefinitionName when calling getResourceInfoByReportDefinition'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportDefinitionsApi.getResourceInfoByReportDefinition, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportDefinitionsApi.getResourceInfoByReportDefinition, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + + + // parse inputs $resourcePath = "/reporting/v3/report-definitions/{reportDefinitionName}"; $httpBody = ''; @@ -260,11 +259,8 @@ public function getResourceV2Info($subscriptionType = null, $organizationId = nu */ public function getResourceV2InfoWithHttpInfo($subscriptionType = null, $organizationId = null) { - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportDefinitionsApi.getResourceV2Info, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportDefinitionsApi.getResourceV2Info, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/report-definitions"; $httpBody = ''; diff --git a/lib/Api/ReportDownloadsApi.php b/lib/Api/ReportDownloadsApi.php index 561d440b3..9cd3fa2a7 100644 --- a/lib/Api/ReportDownloadsApi.php +++ b/lib/Api/ReportDownloadsApi.php @@ -131,16 +131,14 @@ public function downloadReportWithHttpInfo($reportDate, $reportName, $organizati self::$logger->error("InvalidArgumentException : Missing the required parameter $reportDate when calling downloadReport"); throw new \InvalidArgumentException('Missing the required parameter $reportDate when calling downloadReport'); } + // verify the required parameter 'reportName' is set if ($reportName === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $reportName when calling downloadReport"); throw new \InvalidArgumentException('Missing the required parameter $reportName when calling downloadReport'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportDownloadsApi.downloadReport, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportDownloadsApi.downloadReport, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/report-downloads"; $httpBody = ''; diff --git a/lib/Api/ReportSubscriptionsApi.php b/lib/Api/ReportSubscriptionsApi.php index 99c8cf558..e69dcadac 100644 --- a/lib/Api/ReportSubscriptionsApi.php +++ b/lib/Api/ReportSubscriptionsApi.php @@ -129,11 +129,8 @@ public function createStandardOrClassicSubscriptionWithHttpInfo($predefinedSubsc self::$logger->error("InvalidArgumentException : Missing the required parameter $predefinedSubscriptionRequestBean when calling createStandardOrClassicSubscription"); throw new \InvalidArgumentException('Missing the required parameter $predefinedSubscriptionRequestBean when calling createStandardOrClassicSubscription'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.createStandardOrClassicSubscription, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.createStandardOrClassicSubscription, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/predefined-report-subscriptions"; $httpBody = ''; @@ -246,11 +243,8 @@ public function createSubscriptionWithHttpInfo($createReportSubscriptionRequest, self::$logger->error("InvalidArgumentException : Missing the required parameter $createReportSubscriptionRequest when calling createSubscription"); throw new \InvalidArgumentException('Missing the required parameter $createReportSubscriptionRequest when calling createSubscription'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.createSubscription, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.createSubscription, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/report-subscriptions"; $httpBody = ''; @@ -363,16 +357,8 @@ public function deleteSubscriptionWithHttpInfo($reportName, $organizationId = nu self::$logger->error("InvalidArgumentException : Missing the required parameter $reportName when calling deleteSubscription"); throw new \InvalidArgumentException('Missing the required parameter $reportName when calling deleteSubscription'); } - if (!preg_match("/[a-zA-Z0-9-_+]+/", $reportName)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"reportName\" when calling ReportSubscriptionsApi.deleteSubscription, must conform to the pattern /[a-zA-Z0-9-_+]+/."); - throw new \InvalidArgumentException('Invalid value for \"reportName\" when calling ReportSubscriptionsApi.deleteSubscription, must conform to the pattern /[a-zA-Z0-9-_+]+/.'); - } - - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.deleteSubscription, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.deleteSubscription, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/report-subscriptions/{reportName}"; $httpBody = ''; @@ -483,11 +469,7 @@ public function getAllSubscriptions($organizationId = null) */ public function getAllSubscriptionsWithHttpInfo($organizationId = null) { - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.getAllSubscriptions, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.getAllSubscriptions, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + // parse inputs $resourcePath = "/reporting/v3/report-subscriptions"; $httpBody = ''; @@ -597,16 +579,8 @@ public function getSubscriptionWithHttpInfo($reportName, $organizationId = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $reportName when calling getSubscription"); throw new \InvalidArgumentException('Missing the required parameter $reportName when calling getSubscription'); } - if (!preg_match("/[a-zA-Z0-9-_+]+/", $reportName)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"reportName\" when calling ReportSubscriptionsApi.getSubscription, must conform to the pattern /[a-zA-Z0-9-_+]+/."); - throw new \InvalidArgumentException('Invalid value for \"reportName\" when calling ReportSubscriptionsApi.getSubscription, must conform to the pattern /[a-zA-Z0-9-_+]+/.'); - } - - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.getSubscription, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportSubscriptionsApi.getSubscription, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/report-subscriptions/{reportName}"; $httpBody = ''; diff --git a/lib/Api/ReportsApi.php b/lib/Api/ReportsApi.php index a69486c40..9969f0cdc 100644 --- a/lib/Api/ReportsApi.php +++ b/lib/Api/ReportsApi.php @@ -129,11 +129,8 @@ public function createReportWithHttpInfo($createAdhocReportRequest, $organizatio self::$logger->error("InvalidArgumentException : Missing the required parameter $createAdhocReportRequest when calling createReport"); throw new \InvalidArgumentException('Missing the required parameter $createAdhocReportRequest when calling createReport'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportsApi.createReport, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportsApi.createReport, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/reports"; $httpBody = ''; @@ -246,11 +243,8 @@ public function getReportByReportIdWithHttpInfo($reportId, $organizationId = nul self::$logger->error("InvalidArgumentException : Missing the required parameter $reportId when calling getReportByReportId"); throw new \InvalidArgumentException('Missing the required parameter $reportId when calling getReportByReportId'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportsApi.getReportByReportId, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportsApi.getReportByReportId, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/reports/{reportId}"; $httpBody = ''; @@ -382,21 +376,25 @@ public function searchReportsWithHttpInfo($startTime, $endTime, $timeQueryType, self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling searchReports"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling searchReports'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling searchReports"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling searchReports'); } + // verify the required parameter 'timeQueryType' is set if ($timeQueryType === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $timeQueryType when calling searchReports"); throw new \InvalidArgumentException('Missing the required parameter $timeQueryType when calling searchReports'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling ReportsApi.searchReports, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling ReportsApi.searchReports, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + + + + + + // parse inputs $resourcePath = "/reporting/v3/reports"; $httpBody = ''; diff --git a/lib/Api/RetrievalDetailsApi.php b/lib/Api/RetrievalDetailsApi.php index f43b58f05..70a3b1e68 100644 --- a/lib/Api/RetrievalDetailsApi.php +++ b/lib/Api/RetrievalDetailsApi.php @@ -131,16 +131,14 @@ public function getRetrievalDetailsWithHttpInfo($startTime, $endTime, $organizat self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getRetrievalDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getRetrievalDetails'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getRetrievalDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getRetrievalDetails'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling RetrievalDetailsApi.getRetrievalDetails, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling RetrievalDetailsApi.getRetrievalDetails, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/retrieval-details"; $httpBody = ''; diff --git a/lib/Api/RetrievalSummariesApi.php b/lib/Api/RetrievalSummariesApi.php index 9e23fa9f1..84ca19f15 100644 --- a/lib/Api/RetrievalSummariesApi.php +++ b/lib/Api/RetrievalSummariesApi.php @@ -131,16 +131,14 @@ public function getRetrievalSummaryWithHttpInfo($startTime, $endTime, $organizat self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getRetrievalSummary"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getRetrievalSummary'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getRetrievalSummary"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getRetrievalSummary'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling RetrievalSummariesApi.getRetrievalSummary, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling RetrievalSummariesApi.getRetrievalSummary, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/reporting/v3/retrieval-summaries"; $httpBody = ''; diff --git a/lib/Api/ReversalApi.php b/lib/Api/ReversalApi.php index 2295d533b..e0c88aaee 100644 --- a/lib/Api/ReversalApi.php +++ b/lib/Api/ReversalApi.php @@ -129,11 +129,13 @@ public function authReversalWithHttpInfo($id, $authReversalRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling authReversal"); throw new \InvalidArgumentException('Missing the required parameter $id when calling authReversal'); } + // verify the required parameter 'authReversalRequest' is set if ($authReversalRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $authReversalRequest when calling authReversal"); throw new \InvalidArgumentException('Missing the required parameter $authReversalRequest when calling authReversal'); } + // parse inputs $resourcePath = "/pts/v2/payments/{id}/reversals"; $httpBody = ''; @@ -255,6 +257,7 @@ public function mitReversalWithHttpInfo($mitReversalRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $mitReversalRequest when calling mitReversal"); throw new \InvalidArgumentException('Missing the required parameter $mitReversalRequest when calling mitReversal'); } + // parse inputs $resourcePath = "/pts/v2/reversals"; $httpBody = ''; diff --git a/lib/Api/SearchTransactionsApi.php b/lib/Api/SearchTransactionsApi.php index 01713327b..70138cfbb 100644 --- a/lib/Api/SearchTransactionsApi.php +++ b/lib/Api/SearchTransactionsApi.php @@ -127,6 +127,7 @@ public function createSearchWithHttpInfo($createSearchRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createSearchRequest when calling createSearch"); throw new \InvalidArgumentException('Missing the required parameter $createSearchRequest when calling createSearch'); } + // parse inputs $resourcePath = "/tss/v2/searches"; $httpBody = ''; @@ -240,6 +241,7 @@ public function getSearchWithHttpInfo($searchId) self::$logger->error("InvalidArgumentException : Missing the required parameter $searchId when calling getSearch"); throw new \InvalidArgumentException('Missing the required parameter $searchId when calling getSearch'); } + // parse inputs $resourcePath = "/tss/v2/searches/{searchId}"; $httpBody = ''; diff --git a/lib/Api/SecureFileShareApi.php b/lib/Api/SecureFileShareApi.php index ab8f93a1b..5fbf3c2ba 100644 --- a/lib/Api/SecureFileShareApi.php +++ b/lib/Api/SecureFileShareApi.php @@ -129,11 +129,8 @@ public function getFileWithHttpInfo($fileId, $organizationId = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $fileId when calling getFile"); throw new \InvalidArgumentException('Missing the required parameter $fileId when calling getFile'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling SecureFileShareApi.getFile, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling SecureFileShareApi.getFile, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - + + // parse inputs $resourcePath = "/sfs/v1/files/{fileId}"; $httpBody = ''; @@ -251,21 +248,15 @@ public function getFileDetailWithHttpInfo($startDate, $endDate, $organizationId self::$logger->error("InvalidArgumentException : Missing the required parameter $startDate when calling getFileDetail"); throw new \InvalidArgumentException('Missing the required parameter $startDate when calling getFileDetail'); } + // verify the required parameter 'endDate' is set if ($endDate === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endDate when calling getFileDetail"); throw new \InvalidArgumentException('Missing the required parameter $endDate when calling getFileDetail'); } - if (!is_null($organizationId) && !preg_match("/[a-zA-Z0-9-_]+/", $organizationId)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"organizationId\" when calling SecureFileShareApi.getFileDetail, must conform to the pattern /[a-zA-Z0-9-_]+/."); - throw new \InvalidArgumentException('Invalid value for \"organizationId\" when calling SecureFileShareApi.getFileDetail, must conform to the pattern /[a-zA-Z0-9-_]+/.'); - } - - if (!is_null($name) && !preg_match("/[a-zA-Z0-9-_\\.]+/", $name)) { - self::$logger->error("InvalidArgumentException : Invalid value for \"name\" when calling SecureFileShareApi.getFileDetail, must conform to the pattern /[a-zA-Z0-9-_\\.]+/."); - throw new \InvalidArgumentException('Invalid value for \"name\" when calling SecureFileShareApi.getFileDetail, must conform to the pattern /[a-zA-Z0-9-_\\.]+/.'); - } - + + + // parse inputs $resourcePath = "/sfs/v1/file-details"; $httpBody = ''; diff --git a/lib/Api/SubscriptionsApi.php b/lib/Api/SubscriptionsApi.php index 5630a8ef4..767f67bc0 100644 --- a/lib/Api/SubscriptionsApi.php +++ b/lib/Api/SubscriptionsApi.php @@ -127,6 +127,7 @@ public function activateSubscriptionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling activateSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling activateSubscription'); } + // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}/activate"; $httpBody = ''; @@ -245,6 +246,7 @@ public function cancelSubscriptionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling cancelSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling cancelSubscription'); } + // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}/cancel"; $httpBody = ''; @@ -363,6 +365,7 @@ public function createSubscriptionWithHttpInfo($createSubscriptionRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createSubscriptionRequest when calling createSubscription"); throw new \InvalidArgumentException('Missing the required parameter $createSubscriptionRequest when calling createSubscription'); } + // parse inputs $resourcePath = "/rbs/v1/subscriptions"; $httpBody = ''; @@ -477,6 +480,10 @@ public function getAllSubscriptions($offset = null, $limit = null, $code = null, */ public function getAllSubscriptionsWithHttpInfo($offset = null, $limit = null, $code = null, $status = null) { + + + + // parse inputs $resourcePath = "/rbs/v1/subscriptions"; $httpBody = ''; @@ -603,6 +610,7 @@ public function getSubscriptionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getSubscription'); } + // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}"; $httpBody = ''; @@ -820,6 +828,7 @@ public function suspendSubscriptionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling suspendSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling suspendSubscription'); } + // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}/suspend"; $httpBody = ''; @@ -940,11 +949,13 @@ public function updateSubscriptionWithHttpInfo($id, $updateSubscription) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling updateSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling updateSubscription'); } + // verify the required parameter 'updateSubscription' is set if ($updateSubscription === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updateSubscription when calling updateSubscription"); throw new \InvalidArgumentException('Missing the required parameter $updateSubscription when calling updateSubscription'); } + // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}"; $httpBody = ''; diff --git a/lib/Api/SymmetricKeyManagementApi.php b/lib/Api/SymmetricKeyManagementApi.php index 63f9040ab..28f30e92e 100644 --- a/lib/Api/SymmetricKeyManagementApi.php +++ b/lib/Api/SymmetricKeyManagementApi.php @@ -127,6 +127,7 @@ public function createV2SharedSecretKeysWithHttpInfo($createSharedSecretKeysRequ self::$logger->error("InvalidArgumentException : Missing the required parameter $createSharedSecretKeysRequest when calling createV2SharedSecretKeys"); throw new \InvalidArgumentException('Missing the required parameter $createSharedSecretKeysRequest when calling createV2SharedSecretKeys'); } + // parse inputs $resourcePath = "/kms/v2/keys-sym"; $httpBody = ''; @@ -242,11 +243,13 @@ public function createV2SharedSecretKeysVerifiWithHttpInfo($vIcDomain, $createSh self::$logger->error("InvalidArgumentException : Missing the required parameter $vIcDomain when calling createV2SharedSecretKeysVerifi"); throw new \InvalidArgumentException('Missing the required parameter $vIcDomain when calling createV2SharedSecretKeysVerifi'); } + // verify the required parameter 'createSharedSecretKeysVerifiRequest' is set if ($createSharedSecretKeysVerifiRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $createSharedSecretKeysVerifiRequest when calling createV2SharedSecretKeysVerifi"); throw new \InvalidArgumentException('Missing the required parameter $createSharedSecretKeysVerifiRequest when calling createV2SharedSecretKeysVerifi'); } + // parse inputs $resourcePath = "/kms/v2/keys-sym/verifi"; $httpBody = ''; @@ -364,6 +367,7 @@ public function deleteBulkSymmetricKeysWithHttpInfo($deleteBulkSymmetricKeysRequ self::$logger->error("InvalidArgumentException : Missing the required parameter $deleteBulkSymmetricKeysRequest when calling deleteBulkSymmetricKeys"); throw new \InvalidArgumentException('Missing the required parameter $deleteBulkSymmetricKeysRequest when calling deleteBulkSymmetricKeys'); } + // parse inputs $resourcePath = "/kms/v2/keys-sym/deletes"; $httpBody = ''; @@ -477,6 +481,7 @@ public function getKeyDetailsWithHttpInfo($keyId) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling getKeyDetails"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling getKeyDetails'); } + // parse inputs $resourcePath = "/kms/v2/keys-sym/{keyId}"; $httpBody = ''; diff --git a/lib/Api/TaxesApi.php b/lib/Api/TaxesApi.php index 11ae5d063..d94fbb8c9 100644 --- a/lib/Api/TaxesApi.php +++ b/lib/Api/TaxesApi.php @@ -127,6 +127,7 @@ public function calculateTaxWithHttpInfo($taxRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $taxRequest when calling calculateTax"); throw new \InvalidArgumentException('Missing the required parameter $taxRequest when calling calculateTax'); } + // parse inputs $resourcePath = "/vas/v2/tax"; $httpBody = ''; @@ -242,11 +243,13 @@ public function voidTaxWithHttpInfo($voidTaxRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidTaxRequest when calling voidTax"); throw new \InvalidArgumentException('Missing the required parameter $voidTaxRequest when calling voidTax'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidTax"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidTax'); } + // parse inputs $resourcePath = "/vas/v2/tax/{id}"; $httpBody = ''; diff --git a/lib/Api/TokenApi.php b/lib/Api/TokenApi.php index 22e4c7255..f89305fff 100644 --- a/lib/Api/TokenApi.php +++ b/lib/Api/TokenApi.php @@ -131,13 +131,14 @@ public function postTokenPaymentCredentialsWithHttpInfo($tokenId, $postPaymentCr self::$logger->error("InvalidArgumentException : Missing the required parameter $tokenId when calling postTokenPaymentCredentials"); throw new \InvalidArgumentException('Missing the required parameter $tokenId when calling postTokenPaymentCredentials'); } - + // verify the required parameter 'postPaymentCredentialsRequest' is set if ($postPaymentCredentialsRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $postPaymentCredentialsRequest when calling postTokenPaymentCredentials"); throw new \InvalidArgumentException('Missing the required parameter $postPaymentCredentialsRequest when calling postTokenPaymentCredentials'); } - + + // parse inputs $resourcePath = "/tms/v2/tokens/{tokenId}/payment-credentials"; $httpBody = ''; diff --git a/lib/Api/TransactionBatchesApi.php b/lib/Api/TransactionBatchesApi.php index 643e94e02..959d4d218 100644 --- a/lib/Api/TransactionBatchesApi.php +++ b/lib/Api/TransactionBatchesApi.php @@ -131,6 +131,9 @@ public function getTransactionBatchDetailsWithHttpInfo($id, $uploadDate = null, self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getTransactionBatchDetails"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getTransactionBatchDetails'); } + + + // parse inputs $resourcePath = "/pts/v1/transaction-batch-details/{id}"; $httpBody = ''; @@ -263,6 +266,7 @@ public function getTransactionBatchIdWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getTransactionBatchId"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getTransactionBatchId'); } + // parse inputs $resourcePath = "/pts/v1/transaction-batches/{id}"; $httpBody = ''; @@ -391,11 +395,13 @@ public function getTransactionBatchesWithHttpInfo($startTime, $endTime) self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getTransactionBatches"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getTransactionBatches'); } + // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getTransactionBatches"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getTransactionBatches'); } + // parse inputs $resourcePath = "/pts/v1/transaction-batches"; $httpBody = ''; diff --git a/lib/Api/TransactionDetailsApi.php b/lib/Api/TransactionDetailsApi.php index 61fbe30b1..711fa39a4 100644 --- a/lib/Api/TransactionDetailsApi.php +++ b/lib/Api/TransactionDetailsApi.php @@ -127,6 +127,7 @@ public function getTransactionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getTransaction"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getTransaction'); } + // parse inputs $resourcePath = "/tss/v2/transactions/{id}"; $httpBody = ''; diff --git a/lib/Api/TransientTokenDataApi.php b/lib/Api/TransientTokenDataApi.php index 42122cafa..43b439089 100644 --- a/lib/Api/TransientTokenDataApi.php +++ b/lib/Api/TransientTokenDataApi.php @@ -127,6 +127,7 @@ public function getPaymentCredentialsForTransientTokenWithHttpInfo($paymentCrede self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentCredentialsReference when calling getPaymentCredentialsForTransientToken"); throw new \InvalidArgumentException('Missing the required parameter $paymentCredentialsReference when calling getPaymentCredentialsForTransientToken'); } + // parse inputs $resourcePath = "/flex/v2/payment-credentials/{paymentCredentialsReference}"; $httpBody = ''; @@ -233,6 +234,7 @@ public function getTransactionForTransientTokenWithHttpInfo($transientToken) self::$logger->error("InvalidArgumentException : Missing the required parameter $transientToken when calling getTransactionForTransientToken"); throw new \InvalidArgumentException('Missing the required parameter $transientToken when calling getTransactionForTransientToken'); } + // parse inputs $resourcePath = "/up/v1/payment-details/{transientToken}"; $httpBody = ''; diff --git a/lib/Api/UnifiedCheckoutCaptureContextApi.php b/lib/Api/UnifiedCheckoutCaptureContextApi.php index 0299362eb..dd0243256 100644 --- a/lib/Api/UnifiedCheckoutCaptureContextApi.php +++ b/lib/Api/UnifiedCheckoutCaptureContextApi.php @@ -127,6 +127,7 @@ public function generateUnifiedCheckoutCaptureContextWithHttpInfo($generateUnifi self::$logger->error("InvalidArgumentException : Missing the required parameter $generateUnifiedCheckoutCaptureContextRequest when calling generateUnifiedCheckoutCaptureContext"); throw new \InvalidArgumentException('Missing the required parameter $generateUnifiedCheckoutCaptureContextRequest when calling generateUnifiedCheckoutCaptureContext'); } + // parse inputs $resourcePath = "/up/v1/capture-contexts"; $httpBody = ''; diff --git a/lib/Api/UserManagementApi.php b/lib/Api/UserManagementApi.php index d830010e0..b10d1ecf5 100644 --- a/lib/Api/UserManagementApi.php +++ b/lib/Api/UserManagementApi.php @@ -128,6 +128,10 @@ public function getUsers($organizationId = null, $userName = null, $permissionId */ public function getUsersWithHttpInfo($organizationId = null, $userName = null, $permissionId = null, $roleId = null) { + + + + // parse inputs $resourcePath = "/ums/v1/users"; $httpBody = ''; diff --git a/lib/Api/UserManagementSearchApi.php b/lib/Api/UserManagementSearchApi.php index d2c76427a..b7e1f2c49 100644 --- a/lib/Api/UserManagementSearchApi.php +++ b/lib/Api/UserManagementSearchApi.php @@ -127,6 +127,7 @@ public function searchUsersWithHttpInfo($searchRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $searchRequest when calling searchUsers"); throw new \InvalidArgumentException('Missing the required parameter $searchRequest when calling searchUsers'); } + // parse inputs $resourcePath = "/ums/v1/users/search"; $httpBody = ''; diff --git a/lib/Api/VerificationApi.php b/lib/Api/VerificationApi.php index 4f91d3337..25c89040d 100644 --- a/lib/Api/VerificationApi.php +++ b/lib/Api/VerificationApi.php @@ -127,6 +127,7 @@ public function validateExportComplianceWithHttpInfo($validateExportComplianceRe self::$logger->error("InvalidArgumentException : Missing the required parameter $validateExportComplianceRequest when calling validateExportCompliance"); throw new \InvalidArgumentException('Missing the required parameter $validateExportComplianceRequest when calling validateExportCompliance'); } + // parse inputs $resourcePath = "/risk/v1/export-compliance-inquiries"; $httpBody = ''; @@ -240,6 +241,7 @@ public function verifyCustomerAddressWithHttpInfo($verifyCustomerAddressRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $verifyCustomerAddressRequest when calling verifyCustomerAddress"); throw new \InvalidArgumentException('Missing the required parameter $verifyCustomerAddressRequest when calling verifyCustomerAddress'); } + // parse inputs $resourcePath = "/risk/v1/address-verifications"; $httpBody = ''; diff --git a/lib/Api/VoidApi.php b/lib/Api/VoidApi.php index c92f5183c..4909b25b2 100644 --- a/lib/Api/VoidApi.php +++ b/lib/Api/VoidApi.php @@ -127,6 +127,7 @@ public function mitVoidWithHttpInfo($mitVoidRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $mitVoidRequest when calling mitVoid"); throw new \InvalidArgumentException('Missing the required parameter $mitVoidRequest when calling mitVoid'); } + // parse inputs $resourcePath = "/pts/v2/voids"; $httpBody = ''; @@ -242,11 +243,13 @@ public function voidCaptureWithHttpInfo($voidCaptureRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidCaptureRequest when calling voidCapture"); throw new \InvalidArgumentException('Missing the required parameter $voidCaptureRequest when calling voidCapture'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidCapture"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidCapture'); } + // parse inputs $resourcePath = "/pts/v2/captures/{id}/voids"; $httpBody = ''; @@ -370,11 +373,13 @@ public function voidCreditWithHttpInfo($voidCreditRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidCreditRequest when calling voidCredit"); throw new \InvalidArgumentException('Missing the required parameter $voidCreditRequest when calling voidCredit'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidCredit"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidCredit'); } + // parse inputs $resourcePath = "/pts/v2/credits/{id}/voids"; $httpBody = ''; @@ -498,11 +503,13 @@ public function voidPaymentWithHttpInfo($voidPaymentRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidPaymentRequest when calling voidPayment"); throw new \InvalidArgumentException('Missing the required parameter $voidPaymentRequest when calling voidPayment'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidPayment"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidPayment'); } + // parse inputs $resourcePath = "/pts/v2/payments/{id}/voids"; $httpBody = ''; @@ -626,11 +633,13 @@ public function voidRefundWithHttpInfo($voidRefundRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidRefundRequest when calling voidRefund"); throw new \InvalidArgumentException('Missing the required parameter $voidRefundRequest when calling voidRefund'); } + // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidRefund"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidRefund'); } + // parse inputs $resourcePath = "/pts/v2/refunds/{id}/voids"; $httpBody = ''; From 447070a3bad507f964a2565caf5fb4c1cd74ea79 Mon Sep 17 00:00:00 2001 From: gaubansa Date: Wed, 19 Jun 2024 14:36:12 +0530 Subject: [PATCH 11/17] removed extra spacing --- generator/cybersource-php-template/api.mustache | 1 - 1 file changed, 1 deletion(-) diff --git a/generator/cybersource-php-template/api.mustache b/generator/cybersource-php-template/api.mustache index 5419722dc..ccf727e69 100644 --- a/generator/cybersource-php-template/api.mustache +++ b/generator/cybersource-php-template/api.mustache @@ -142,7 +142,6 @@ use \{{invokerPackage}}\Logging\LogFactory as LogFactory; throw new \InvalidArgumentException('Missing the required parameter ${{paramName}} when calling {{operationId}}'); } {{/required}} - {{/allParams}} // parse inputs $resourcePath = "{{{path}}}"; From e0bb60814e625d309cc3e84b31f73177f7378c88 Mon Sep 17 00:00:00 2001 From: gaubansa Date: Wed, 19 Jun 2024 14:41:41 +0530 Subject: [PATCH 12/17] removed extra spacing from model classes --- lib/Api/AsymmetricKeyManagementApi.php | 5 ----- lib/Api/BatchesApi.php | 7 ------- lib/Api/BillingAgreementsApi.php | 5 ----- lib/Api/CaptureApi.php | 2 -- lib/Api/ChargebackDetailsApi.php | 3 --- lib/Api/ChargebackSummariesApi.php | 3 --- lib/Api/ConversionDetailsApi.php | 3 --- lib/Api/CreateNewWebhooksApi.php | 6 ------ lib/Api/CreditApi.php | 1 - lib/Api/CustomerApi.php | 10 ---------- lib/Api/CustomerPaymentInstrumentApi.php | 18 ------------------ lib/Api/CustomerShippingAddressApi.php | 18 ------------------ lib/Api/DecisionManagerApi.php | 9 --------- lib/Api/DownloadDTDApi.php | 1 - lib/Api/DownloadXSDApi.php | 1 - lib/Api/EMVTagDetailsApi.php | 1 - lib/Api/InstrumentIdentifierApi.php | 17 ----------------- lib/Api/InterchangeClearingLevelDetailsApi.php | 3 --- lib/Api/InvoiceSettingsApi.php | 1 - lib/Api/InvoicesApi.php | 9 --------- lib/Api/KeymanagementApi.php | 8 -------- lib/Api/KeymanagementpasswordApi.php | 2 -- lib/Api/KeymanagementpgpApi.php | 2 -- lib/Api/KeymanagementscmpApi.php | 2 -- lib/Api/ManageWebhooksApi.php | 11 ----------- lib/Api/MerchantBoardingApi.php | 3 --- lib/Api/MicroformIntegrationApi.php | 1 - lib/Api/NetFundingsApi.php | 4 ---- lib/Api/NotificationOfChangesApi.php | 2 -- lib/Api/PayerAuthenticationApi.php | 3 --- lib/Api/PaymentBatchSummariesApi.php | 6 ------ lib/Api/PaymentInstrumentApi.php | 10 ---------- lib/Api/PaymentsApi.php | 10 ---------- lib/Api/PayoutsApi.php | 1 - lib/Api/PlansApi.php | 12 ------------ lib/Api/PurchaseAndRefundDetailsApi.php | 8 -------- lib/Api/PushFundsApi.php | 7 ------- lib/Api/RefundApi.php | 4 ---- lib/Api/ReplayWebhooksApi.php | 2 -- lib/Api/ReportDefinitionsApi.php | 6 ------ lib/Api/ReportDownloadsApi.php | 3 --- lib/Api/ReportSubscriptionsApi.php | 9 --------- lib/Api/ReportsApi.php | 13 ------------- lib/Api/RetrievalDetailsApi.php | 3 --- lib/Api/RetrievalSummariesApi.php | 3 --- lib/Api/ReversalApi.php | 3 --- lib/Api/SearchTransactionsApi.php | 2 -- lib/Api/SecureFileShareApi.php | 6 ------ lib/Api/SubscriptionsApi.php | 11 ----------- lib/Api/SymmetricKeyManagementApi.php | 5 ----- lib/Api/TaxesApi.php | 3 --- lib/Api/TokenApi.php | 3 --- lib/Api/TransactionBatchesApi.php | 6 ------ lib/Api/TransactionDetailsApi.php | 1 - lib/Api/TransientTokenDataApi.php | 2 -- lib/Api/UnifiedCheckoutCaptureContextApi.php | 1 - lib/Api/UserManagementApi.php | 4 ---- lib/Api/UserManagementSearchApi.php | 1 - lib/Api/VerificationApi.php | 2 -- lib/Api/VoidApi.php | 9 --------- 60 files changed, 317 deletions(-) diff --git a/lib/Api/AsymmetricKeyManagementApi.php b/lib/Api/AsymmetricKeyManagementApi.php index c8088f28c..ac7948c55 100644 --- a/lib/Api/AsymmetricKeyManagementApi.php +++ b/lib/Api/AsymmetricKeyManagementApi.php @@ -127,7 +127,6 @@ public function createP12KeysWithHttpInfo($createP12KeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createP12KeysRequest when calling createP12Keys"); throw new \InvalidArgumentException('Missing the required parameter $createP12KeysRequest when calling createP12Keys'); } - // parse inputs $resourcePath = "/kms/v2/keys-asym"; $httpBody = ''; @@ -241,7 +240,6 @@ public function deleteBulkP12KeysWithHttpInfo($deleteBulkP12KeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $deleteBulkP12KeysRequest when calling deleteBulkP12Keys"); throw new \InvalidArgumentException('Missing the required parameter $deleteBulkP12KeysRequest when calling deleteBulkP12Keys'); } - // parse inputs $resourcePath = "/kms/v2/keys-asym/deletes"; $httpBody = ''; @@ -355,7 +353,6 @@ public function getP12KeyDetailsWithHttpInfo($keyId) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling getP12KeyDetails"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling getP12KeyDetails'); } - // parse inputs $resourcePath = "/kms/v2/keys-asym/{keyId}"; $httpBody = ''; @@ -472,13 +469,11 @@ public function updateAsymKeyWithHttpInfo($keyId, $updateAsymKeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling updateAsymKey"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling updateAsymKey'); } - // verify the required parameter 'updateAsymKeysRequest' is set if ($updateAsymKeysRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updateAsymKeysRequest when calling updateAsymKey"); throw new \InvalidArgumentException('Missing the required parameter $updateAsymKeysRequest when calling updateAsymKey'); } - // parse inputs $resourcePath = "/kms/v2/keys-asym/{keyId}"; $httpBody = ''; diff --git a/lib/Api/BatchesApi.php b/lib/Api/BatchesApi.php index 4f33cb2b7..d21bf84aa 100644 --- a/lib/Api/BatchesApi.php +++ b/lib/Api/BatchesApi.php @@ -127,7 +127,6 @@ public function getBatchReportWithHttpInfo($batchId) self::$logger->error("InvalidArgumentException : Missing the required parameter $batchId when calling getBatchReport"); throw new \InvalidArgumentException('Missing the required parameter $batchId when calling getBatchReport'); } - // parse inputs $resourcePath = "/accountupdater/v1/batches/{batchId}/report"; $httpBody = ''; @@ -238,7 +237,6 @@ public function getBatchStatusWithHttpInfo($batchId) self::$logger->error("InvalidArgumentException : Missing the required parameter $batchId when calling getBatchStatus"); throw new \InvalidArgumentException('Missing the required parameter $batchId when calling getBatchStatus'); } - // parse inputs $resourcePath = "/accountupdater/v1/batches/{batchId}/status"; $httpBody = ''; @@ -350,10 +348,6 @@ public function getBatchesList($offset = '0', $limit = '20', $fromDate = null, $ */ public function getBatchesListWithHttpInfo($offset = '0', $limit = '20', $fromDate = null, $toDate = null) { - - - - // parse inputs $resourcePath = "/accountupdater/v1/batches"; $httpBody = ''; @@ -480,7 +474,6 @@ public function postBatchWithHttpInfo($body) self::$logger->error("InvalidArgumentException : Missing the required parameter $body when calling postBatch"); throw new \InvalidArgumentException('Missing the required parameter $body when calling postBatch'); } - // parse inputs $resourcePath = "/accountupdater/v1/batches"; $httpBody = ''; diff --git a/lib/Api/BillingAgreementsApi.php b/lib/Api/BillingAgreementsApi.php index 67ef37a1d..aee1e98f1 100644 --- a/lib/Api/BillingAgreementsApi.php +++ b/lib/Api/BillingAgreementsApi.php @@ -129,13 +129,11 @@ public function billingAgreementsDeRegistrationWithHttpInfo($modifyBillingAgreem self::$logger->error("InvalidArgumentException : Missing the required parameter $modifyBillingAgreement when calling billingAgreementsDeRegistration"); throw new \InvalidArgumentException('Missing the required parameter $modifyBillingAgreement when calling billingAgreementsDeRegistration'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling billingAgreementsDeRegistration"); throw new \InvalidArgumentException('Missing the required parameter $id when calling billingAgreementsDeRegistration'); } - // parse inputs $resourcePath = "/pts/v2/billing-agreements/{id}"; $httpBody = ''; @@ -259,13 +257,11 @@ public function billingAgreementsIntimationWithHttpInfo($intimateBillingAgreemen self::$logger->error("InvalidArgumentException : Missing the required parameter $intimateBillingAgreement when calling billingAgreementsIntimation"); throw new \InvalidArgumentException('Missing the required parameter $intimateBillingAgreement when calling billingAgreementsIntimation'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling billingAgreementsIntimation"); throw new \InvalidArgumentException('Missing the required parameter $id when calling billingAgreementsIntimation'); } - // parse inputs $resourcePath = "/pts/v2/billing-agreements/{id}/intimations"; $httpBody = ''; @@ -387,7 +383,6 @@ public function billingAgreementsRegistrationWithHttpInfo($createBillingAgreemen self::$logger->error("InvalidArgumentException : Missing the required parameter $createBillingAgreement when calling billingAgreementsRegistration"); throw new \InvalidArgumentException('Missing the required parameter $createBillingAgreement when calling billingAgreementsRegistration'); } - // parse inputs $resourcePath = "/pts/v2/billing-agreements"; $httpBody = ''; diff --git a/lib/Api/CaptureApi.php b/lib/Api/CaptureApi.php index 09bd8482b..8552e6652 100644 --- a/lib/Api/CaptureApi.php +++ b/lib/Api/CaptureApi.php @@ -129,13 +129,11 @@ public function capturePaymentWithHttpInfo($capturePaymentRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $capturePaymentRequest when calling capturePayment"); throw new \InvalidArgumentException('Missing the required parameter $capturePaymentRequest when calling capturePayment'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling capturePayment"); throw new \InvalidArgumentException('Missing the required parameter $id when calling capturePayment'); } - // parse inputs $resourcePath = "/pts/v2/payments/{id}/captures"; $httpBody = ''; diff --git a/lib/Api/ChargebackDetailsApi.php b/lib/Api/ChargebackDetailsApi.php index 9d4bf3073..cf672840a 100644 --- a/lib/Api/ChargebackDetailsApi.php +++ b/lib/Api/ChargebackDetailsApi.php @@ -131,14 +131,11 @@ public function getChargebackDetailsWithHttpInfo($startTime, $endTime, $organiza self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getChargebackDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getChargebackDetails'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getChargebackDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getChargebackDetails'); } - - // parse inputs $resourcePath = "/reporting/v3/chargeback-details"; $httpBody = ''; diff --git a/lib/Api/ChargebackSummariesApi.php b/lib/Api/ChargebackSummariesApi.php index 0fe6b4e81..18df55be1 100644 --- a/lib/Api/ChargebackSummariesApi.php +++ b/lib/Api/ChargebackSummariesApi.php @@ -131,14 +131,11 @@ public function getChargebackSummariesWithHttpInfo($startTime, $endTime, $organi self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getChargebackSummaries"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getChargebackSummaries'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getChargebackSummaries"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getChargebackSummaries'); } - - // parse inputs $resourcePath = "/reporting/v3/chargeback-summaries"; $httpBody = ''; diff --git a/lib/Api/ConversionDetailsApi.php b/lib/Api/ConversionDetailsApi.php index 93fa89955..bc68d287c 100644 --- a/lib/Api/ConversionDetailsApi.php +++ b/lib/Api/ConversionDetailsApi.php @@ -131,14 +131,11 @@ public function getConversionDetailWithHttpInfo($startTime, $endTime, $organizat self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getConversionDetail"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getConversionDetail'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getConversionDetail"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getConversionDetail'); } - - // parse inputs $resourcePath = "/reporting/v3/conversion-details"; $httpBody = ''; diff --git a/lib/Api/CreateNewWebhooksApi.php b/lib/Api/CreateNewWebhooksApi.php index 32b8e9f96..43ffac111 100644 --- a/lib/Api/CreateNewWebhooksApi.php +++ b/lib/Api/CreateNewWebhooksApi.php @@ -124,7 +124,6 @@ public function createWebhookSubscription($createWebhookRequest = null) */ public function createWebhookSubscriptionWithHttpInfo($createWebhookRequest = null) { - // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks"; $httpBody = ''; @@ -232,7 +231,6 @@ public function findProductsToSubscribeWithHttpInfo($organizationId) self::$logger->error("InvalidArgumentException : Missing the required parameter $organizationId when calling findProductsToSubscribe"); throw new \InvalidArgumentException('Missing the required parameter $organizationId when calling findProductsToSubscribe'); } - // parse inputs $resourcePath = "/notification-subscriptions/v1/products/{organizationId}"; $httpBody = ''; @@ -347,15 +345,11 @@ public function saveSymEgressKeyWithHttpInfo($vCSenderOrganizationId, $vCPermiss self::$logger->error("InvalidArgumentException : Missing the required parameter $vCSenderOrganizationId when calling saveSymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $vCSenderOrganizationId when calling saveSymEgressKey'); } - // verify the required parameter 'vCPermissions' is set if ($vCPermissions === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCPermissions when calling saveSymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $vCPermissions when calling saveSymEgressKey'); } - - - // parse inputs $resourcePath = "/kms/egress/v2/keys-sym"; $httpBody = ''; diff --git a/lib/Api/CreditApi.php b/lib/Api/CreditApi.php index 62cc46afc..2cfe3cc2e 100644 --- a/lib/Api/CreditApi.php +++ b/lib/Api/CreditApi.php @@ -127,7 +127,6 @@ public function createCreditWithHttpInfo($createCreditRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createCreditRequest when calling createCredit"); throw new \InvalidArgumentException('Missing the required parameter $createCreditRequest when calling createCredit'); } - // parse inputs $resourcePath = "/pts/v2/credits"; $httpBody = ''; diff --git a/lib/Api/CustomerApi.php b/lib/Api/CustomerApi.php index 969552884..f62f920ad 100644 --- a/lib/Api/CustomerApi.php +++ b/lib/Api/CustomerApi.php @@ -129,8 +129,6 @@ public function deleteCustomerWithHttpInfo($customerId, $profileId = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling deleteCustomer"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling deleteCustomer'); } - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}"; $httpBody = ''; @@ -263,8 +261,6 @@ public function getCustomerWithHttpInfo($customerId, $profileId = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomer"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomer'); } - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}"; $httpBody = ''; @@ -405,15 +401,11 @@ public function patchCustomerWithHttpInfo($customerId, $patchCustomerRequest, $p self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling patchCustomer"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling patchCustomer'); } - // verify the required parameter 'patchCustomerRequest' is set if ($patchCustomerRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchCustomerRequest when calling patchCustomer"); throw new \InvalidArgumentException('Missing the required parameter $patchCustomerRequest when calling patchCustomer'); } - - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}"; $httpBody = ''; @@ -565,8 +557,6 @@ public function postCustomerWithHttpInfo($postCustomerRequest, $profileId = null self::$logger->error("InvalidArgumentException : Missing the required parameter $postCustomerRequest when calling postCustomer"); throw new \InvalidArgumentException('Missing the required parameter $postCustomerRequest when calling postCustomer'); } - - // parse inputs $resourcePath = "/tms/v2/customers"; $httpBody = ''; diff --git a/lib/Api/CustomerPaymentInstrumentApi.php b/lib/Api/CustomerPaymentInstrumentApi.php index dd23591b1..5b9f40cfc 100644 --- a/lib/Api/CustomerPaymentInstrumentApi.php +++ b/lib/Api/CustomerPaymentInstrumentApi.php @@ -131,14 +131,11 @@ public function deleteCustomerPaymentInstrumentWithHttpInfo($customerId, $paymen self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling deleteCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling deleteCustomerPaymentInstrument'); } - // verify the required parameter 'paymentInstrumentId' is set if ($paymentInstrumentId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling deleteCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling deleteCustomerPaymentInstrument'); } - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}"; $httpBody = ''; @@ -285,14 +282,11 @@ public function getCustomerPaymentInstrumentWithHttpInfo($customerId, $paymentIn self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomerPaymentInstrument'); } - // verify the required parameter 'paymentInstrumentId' is set if ($paymentInstrumentId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling getCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling getCustomerPaymentInstrument'); } - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}"; $httpBody = ''; @@ -441,10 +435,6 @@ public function getCustomerPaymentInstrumentsListWithHttpInfo($customerId, $prof self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomerPaymentInstrumentsList"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomerPaymentInstrumentsList'); } - - - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments"; $httpBody = ''; @@ -597,21 +587,16 @@ public function patchCustomersPaymentInstrumentWithHttpInfo($customerId, $paymen self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling patchCustomersPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling patchCustomersPaymentInstrument'); } - // verify the required parameter 'paymentInstrumentId' is set if ($paymentInstrumentId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling patchCustomersPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling patchCustomersPaymentInstrument'); } - // verify the required parameter 'patchCustomerPaymentInstrumentRequest' is set if ($patchCustomerPaymentInstrumentRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchCustomerPaymentInstrumentRequest when calling patchCustomersPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $patchCustomerPaymentInstrumentRequest when calling patchCustomersPaymentInstrument'); } - - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}"; $httpBody = ''; @@ -773,14 +758,11 @@ public function postCustomerPaymentInstrumentWithHttpInfo($customerId, $postCust self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling postCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling postCustomerPaymentInstrument'); } - // verify the required parameter 'postCustomerPaymentInstrumentRequest' is set if ($postCustomerPaymentInstrumentRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $postCustomerPaymentInstrumentRequest when calling postCustomerPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $postCustomerPaymentInstrumentRequest when calling postCustomerPaymentInstrument'); } - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/payment-instruments"; $httpBody = ''; diff --git a/lib/Api/CustomerShippingAddressApi.php b/lib/Api/CustomerShippingAddressApi.php index ef719fd31..3f085bab7 100644 --- a/lib/Api/CustomerShippingAddressApi.php +++ b/lib/Api/CustomerShippingAddressApi.php @@ -131,14 +131,11 @@ public function deleteCustomerShippingAddressWithHttpInfo($customerId, $shipping self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling deleteCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling deleteCustomerShippingAddress'); } - // verify the required parameter 'shippingAddressId' is set if ($shippingAddressId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $shippingAddressId when calling deleteCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $shippingAddressId when calling deleteCustomerShippingAddress'); } - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}"; $httpBody = ''; @@ -285,14 +282,11 @@ public function getCustomerShippingAddressWithHttpInfo($customerId, $shippingAdd self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomerShippingAddress'); } - // verify the required parameter 'shippingAddressId' is set if ($shippingAddressId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $shippingAddressId when calling getCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $shippingAddressId when calling getCustomerShippingAddress'); } - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}"; $httpBody = ''; @@ -441,10 +435,6 @@ public function getCustomerShippingAddressesListWithHttpInfo($customerId, $profi self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling getCustomerShippingAddressesList"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling getCustomerShippingAddressesList'); } - - - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses"; $httpBody = ''; @@ -597,21 +587,16 @@ public function patchCustomersShippingAddressWithHttpInfo($customerId, $shipping self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling patchCustomersShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling patchCustomersShippingAddress'); } - // verify the required parameter 'shippingAddressId' is set if ($shippingAddressId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $shippingAddressId when calling patchCustomersShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $shippingAddressId when calling patchCustomersShippingAddress'); } - // verify the required parameter 'patchCustomerShippingAddressRequest' is set if ($patchCustomerShippingAddressRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchCustomerShippingAddressRequest when calling patchCustomersShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $patchCustomerShippingAddressRequest when calling patchCustomersShippingAddress'); } - - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}"; $httpBody = ''; @@ -773,14 +758,11 @@ public function postCustomerShippingAddressWithHttpInfo($customerId, $postCustom self::$logger->error("InvalidArgumentException : Missing the required parameter $customerId when calling postCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $customerId when calling postCustomerShippingAddress'); } - // verify the required parameter 'postCustomerShippingAddressRequest' is set if ($postCustomerShippingAddressRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $postCustomerShippingAddressRequest when calling postCustomerShippingAddress"); throw new \InvalidArgumentException('Missing the required parameter $postCustomerShippingAddressRequest when calling postCustomerShippingAddress'); } - - // parse inputs $resourcePath = "/tms/v2/customers/{customerId}/shipping-addresses"; $httpBody = ''; diff --git a/lib/Api/DecisionManagerApi.php b/lib/Api/DecisionManagerApi.php index 98e9735b8..96f680948 100644 --- a/lib/Api/DecisionManagerApi.php +++ b/lib/Api/DecisionManagerApi.php @@ -129,13 +129,11 @@ public function actionDecisionManagerCaseWithHttpInfo($id, $caseManagementAction self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling actionDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $id when calling actionDecisionManagerCase'); } - // verify the required parameter 'caseManagementActionsRequest' is set if ($caseManagementActionsRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $caseManagementActionsRequest when calling actionDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $caseManagementActionsRequest when calling actionDecisionManagerCase'); } - // parse inputs $resourcePath = "/risk/v1/decisions/{id}/actions"; $httpBody = ''; @@ -275,13 +273,11 @@ public function addNegativeWithHttpInfo($type, $addNegativeListRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $type when calling addNegative"); throw new \InvalidArgumentException('Missing the required parameter $type when calling addNegative'); } - // verify the required parameter 'addNegativeListRequest' is set if ($addNegativeListRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $addNegativeListRequest when calling addNegative"); throw new \InvalidArgumentException('Missing the required parameter $addNegativeListRequest when calling addNegative'); } - // parse inputs $resourcePath = "/risk/v1/lists/{type}/entries"; $httpBody = ''; @@ -401,13 +397,11 @@ public function commentDecisionManagerCaseWithHttpInfo($id, $caseManagementComme self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling commentDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $id when calling commentDecisionManagerCase'); } - // verify the required parameter 'caseManagementCommentsRequest' is set if ($caseManagementCommentsRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $caseManagementCommentsRequest when calling commentDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $caseManagementCommentsRequest when calling commentDecisionManagerCase'); } - // parse inputs $resourcePath = "/risk/v1/decisions/{id}/comments"; $httpBody = ''; @@ -545,7 +539,6 @@ public function createBundledDecisionManagerCaseWithHttpInfo($createBundledDecis self::$logger->error("InvalidArgumentException : Missing the required parameter $createBundledDecisionManagerCaseRequest when calling createBundledDecisionManagerCase"); throw new \InvalidArgumentException('Missing the required parameter $createBundledDecisionManagerCaseRequest when calling createBundledDecisionManagerCase'); } - // parse inputs $resourcePath = "/risk/v1/decisions"; $httpBody = ''; @@ -661,13 +654,11 @@ public function fraudUpdateWithHttpInfo($id, $fraudMarkingActionRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling fraudUpdate"); throw new \InvalidArgumentException('Missing the required parameter $id when calling fraudUpdate'); } - // verify the required parameter 'fraudMarkingActionRequest' is set if ($fraudMarkingActionRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $fraudMarkingActionRequest when calling fraudUpdate"); throw new \InvalidArgumentException('Missing the required parameter $fraudMarkingActionRequest when calling fraudUpdate'); } - // parse inputs $resourcePath = "/risk/v1/decisions/{id}/marking"; $httpBody = ''; diff --git a/lib/Api/DownloadDTDApi.php b/lib/Api/DownloadDTDApi.php index 84257e558..9dbc4a763 100644 --- a/lib/Api/DownloadDTDApi.php +++ b/lib/Api/DownloadDTDApi.php @@ -127,7 +127,6 @@ public function getDTDV2WithHttpInfo($reportDefinitionNameVersion) self::$logger->error("InvalidArgumentException : Missing the required parameter $reportDefinitionNameVersion when calling getDTDV2"); throw new \InvalidArgumentException('Missing the required parameter $reportDefinitionNameVersion when calling getDTDV2'); } - // parse inputs $resourcePath = "/reporting/v3/dtds/{reportDefinitionNameVersion}"; $httpBody = ''; diff --git a/lib/Api/DownloadXSDApi.php b/lib/Api/DownloadXSDApi.php index a24c51872..b3e757be4 100644 --- a/lib/Api/DownloadXSDApi.php +++ b/lib/Api/DownloadXSDApi.php @@ -127,7 +127,6 @@ public function getXSDV2WithHttpInfo($reportDefinitionNameVersion) self::$logger->error("InvalidArgumentException : Missing the required parameter $reportDefinitionNameVersion when calling getXSDV2"); throw new \InvalidArgumentException('Missing the required parameter $reportDefinitionNameVersion when calling getXSDV2'); } - // parse inputs $resourcePath = "/reporting/v3/xsds/{reportDefinitionNameVersion}"; $httpBody = ''; diff --git a/lib/Api/EMVTagDetailsApi.php b/lib/Api/EMVTagDetailsApi.php index e19008200..bf749bbfc 100644 --- a/lib/Api/EMVTagDetailsApi.php +++ b/lib/Api/EMVTagDetailsApi.php @@ -218,7 +218,6 @@ public function parseEmvTagsWithHttpInfo($body) self::$logger->error("InvalidArgumentException : Missing the required parameter $body when calling parseEmvTags"); throw new \InvalidArgumentException('Missing the required parameter $body when calling parseEmvTags'); } - // parse inputs $resourcePath = "/tss/v2/transactions/emvTagDetails"; $httpBody = ''; diff --git a/lib/Api/InstrumentIdentifierApi.php b/lib/Api/InstrumentIdentifierApi.php index f31acef90..bb4a37560 100644 --- a/lib/Api/InstrumentIdentifierApi.php +++ b/lib/Api/InstrumentIdentifierApi.php @@ -129,8 +129,6 @@ public function deleteInstrumentIdentifierWithHttpInfo($instrumentIdentifierId, self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling deleteInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling deleteInstrumentIdentifier'); } - - // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}"; $httpBody = ''; @@ -263,8 +261,6 @@ public function getInstrumentIdentifierWithHttpInfo($instrumentIdentifierId, $pr self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling getInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling getInstrumentIdentifier'); } - - // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}"; $httpBody = ''; @@ -405,10 +401,6 @@ public function getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo($instr self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling getInstrumentIdentifierPaymentInstrumentsList"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling getInstrumentIdentifierPaymentInstrumentsList'); } - - - - // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}/paymentinstruments"; $httpBody = ''; @@ -559,15 +551,11 @@ public function patchInstrumentIdentifierWithHttpInfo($instrumentIdentifierId, $ self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling patchInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling patchInstrumentIdentifier'); } - // verify the required parameter 'patchInstrumentIdentifierRequest' is set if ($patchInstrumentIdentifierRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchInstrumentIdentifierRequest when calling patchInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $patchInstrumentIdentifierRequest when calling patchInstrumentIdentifier'); } - - - // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}"; $httpBody = ''; @@ -719,8 +707,6 @@ public function postInstrumentIdentifierWithHttpInfo($postInstrumentIdentifierRe self::$logger->error("InvalidArgumentException : Missing the required parameter $postInstrumentIdentifierRequest when calling postInstrumentIdentifier"); throw new \InvalidArgumentException('Missing the required parameter $postInstrumentIdentifierRequest when calling postInstrumentIdentifier'); } - - // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers"; $httpBody = ''; @@ -858,14 +844,11 @@ public function postInstrumentIdentifierEnrollmentWithHttpInfo($instrumentIdenti self::$logger->error("InvalidArgumentException : Missing the required parameter $instrumentIdentifierId when calling postInstrumentIdentifierEnrollment"); throw new \InvalidArgumentException('Missing the required parameter $instrumentIdentifierId when calling postInstrumentIdentifierEnrollment'); } - // verify the required parameter 'postInstrumentIdentifierEnrollmentRequest' is set if ($postInstrumentIdentifierEnrollmentRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $postInstrumentIdentifierEnrollmentRequest when calling postInstrumentIdentifierEnrollment"); throw new \InvalidArgumentException('Missing the required parameter $postInstrumentIdentifierEnrollmentRequest when calling postInstrumentIdentifierEnrollment'); } - - // parse inputs $resourcePath = "/tms/v1/instrumentidentifiers/{instrumentIdentifierId}/enrollment"; $httpBody = ''; diff --git a/lib/Api/InterchangeClearingLevelDetailsApi.php b/lib/Api/InterchangeClearingLevelDetailsApi.php index a2744e2f4..e1b46e034 100644 --- a/lib/Api/InterchangeClearingLevelDetailsApi.php +++ b/lib/Api/InterchangeClearingLevelDetailsApi.php @@ -131,14 +131,11 @@ public function getInterchangeClearingLevelDetailsWithHttpInfo($startTime, $endT self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getInterchangeClearingLevelDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getInterchangeClearingLevelDetails'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getInterchangeClearingLevelDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getInterchangeClearingLevelDetails'); } - - // parse inputs $resourcePath = "/reporting/v3/interchange-clearing-level-details"; $httpBody = ''; diff --git a/lib/Api/InvoiceSettingsApi.php b/lib/Api/InvoiceSettingsApi.php index ccbe288cc..a8b049ffe 100644 --- a/lib/Api/InvoiceSettingsApi.php +++ b/lib/Api/InvoiceSettingsApi.php @@ -226,7 +226,6 @@ public function updateInvoiceSettingsWithHttpInfo($invoiceSettingsRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $invoiceSettingsRequest when calling updateInvoiceSettings"); throw new \InvalidArgumentException('Missing the required parameter $invoiceSettingsRequest when calling updateInvoiceSettings'); } - // parse inputs $resourcePath = "/invoicing/v2/invoiceSettings"; $httpBody = ''; diff --git a/lib/Api/InvoicesApi.php b/lib/Api/InvoicesApi.php index cab4c0ead..4f8ce0a36 100644 --- a/lib/Api/InvoicesApi.php +++ b/lib/Api/InvoicesApi.php @@ -127,7 +127,6 @@ public function createInvoiceWithHttpInfo($createInvoiceRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createInvoiceRequest when calling createInvoice"); throw new \InvalidArgumentException('Missing the required parameter $createInvoiceRequest when calling createInvoice'); } - // parse inputs $resourcePath = "/invoicing/v2/invoices"; $httpBody = ''; @@ -253,14 +252,11 @@ public function getAllInvoicesWithHttpInfo($offset, $limit, $status = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $offset when calling getAllInvoices"); throw new \InvalidArgumentException('Missing the required parameter $offset when calling getAllInvoices'); } - // verify the required parameter 'limit' is set if ($limit === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $limit when calling getAllInvoices"); throw new \InvalidArgumentException('Missing the required parameter $limit when calling getAllInvoices'); } - - // parse inputs $resourcePath = "/invoicing/v2/invoices"; $httpBody = ''; @@ -386,7 +382,6 @@ public function getInvoiceWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getInvoice"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getInvoice'); } - // parse inputs $resourcePath = "/invoicing/v2/invoices/{id}"; $httpBody = ''; @@ -505,7 +500,6 @@ public function performCancelActionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling performCancelAction"); throw new \InvalidArgumentException('Missing the required parameter $id when calling performCancelAction'); } - // parse inputs $resourcePath = "/invoicing/v2/invoices/{id}/cancelation"; $httpBody = ''; @@ -624,7 +618,6 @@ public function performSendActionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling performSendAction"); throw new \InvalidArgumentException('Missing the required parameter $id when calling performSendAction'); } - // parse inputs $resourcePath = "/invoicing/v2/invoices/{id}/delivery"; $httpBody = ''; @@ -745,13 +738,11 @@ public function updateInvoiceWithHttpInfo($id, $updateInvoiceRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling updateInvoice"); throw new \InvalidArgumentException('Missing the required parameter $id when calling updateInvoice'); } - // verify the required parameter 'updateInvoiceRequest' is set if ($updateInvoiceRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updateInvoiceRequest when calling updateInvoice"); throw new \InvalidArgumentException('Missing the required parameter $updateInvoiceRequest when calling updateInvoice'); } - // parse inputs $resourcePath = "/invoicing/v2/invoices/{id}"; $httpBody = ''; diff --git a/lib/Api/KeymanagementApi.php b/lib/Api/KeymanagementApi.php index b37f16e90..d63d2deab 100644 --- a/lib/Api/KeymanagementApi.php +++ b/lib/Api/KeymanagementApi.php @@ -136,14 +136,6 @@ public function searchKeys($offset = null, $limit = null, $sort = null, $organiz */ public function searchKeysWithHttpInfo($offset = null, $limit = null, $sort = null, $organizationIds = null, $keyIds = null, $keyTypes = null, $expirationStartDate = null, $expirationEndDate = null) { - - - - - - - - // parse inputs $resourcePath = "/kms/v2/keys"; $httpBody = ''; diff --git a/lib/Api/KeymanagementpasswordApi.php b/lib/Api/KeymanagementpasswordApi.php index f807505d6..ec3808a29 100644 --- a/lib/Api/KeymanagementpasswordApi.php +++ b/lib/Api/KeymanagementpasswordApi.php @@ -129,13 +129,11 @@ public function updatePasswordWithHttpInfo($keyId, $updatePasswordKeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling updatePassword"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling updatePassword'); } - // verify the required parameter 'updatePasswordKeysRequest' is set if ($updatePasswordKeysRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updatePasswordKeysRequest when calling updatePassword"); throw new \InvalidArgumentException('Missing the required parameter $updatePasswordKeysRequest when calling updatePassword'); } - // parse inputs $resourcePath = "/kms/v2/keys-password/{keyId}"; $httpBody = ''; diff --git a/lib/Api/KeymanagementpgpApi.php b/lib/Api/KeymanagementpgpApi.php index 485f0404c..1341c6cc2 100644 --- a/lib/Api/KeymanagementpgpApi.php +++ b/lib/Api/KeymanagementpgpApi.php @@ -129,13 +129,11 @@ public function updatePGPWithHttpInfo($keyId, $updatePGPKeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling updatePGP"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling updatePGP'); } - // verify the required parameter 'updatePGPKeysRequest' is set if ($updatePGPKeysRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updatePGPKeysRequest when calling updatePGP"); throw new \InvalidArgumentException('Missing the required parameter $updatePGPKeysRequest when calling updatePGP'); } - // parse inputs $resourcePath = "/kms/v2/keys-pgp/{keyId}"; $httpBody = ''; diff --git a/lib/Api/KeymanagementscmpApi.php b/lib/Api/KeymanagementscmpApi.php index 02134bf41..447e1316a 100644 --- a/lib/Api/KeymanagementscmpApi.php +++ b/lib/Api/KeymanagementscmpApi.php @@ -129,13 +129,11 @@ public function updateSCMPWithHttpInfo($keyId, $updatePGPKeysRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling updateSCMP"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling updateSCMP'); } - // verify the required parameter 'updatePGPKeysRequest' is set if ($updatePGPKeysRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updatePGPKeysRequest when calling updateSCMP"); throw new \InvalidArgumentException('Missing the required parameter $updatePGPKeysRequest when calling updateSCMP'); } - // parse inputs $resourcePath = "/kms/v2/keys-scmp/{keyId}"; $httpBody = ''; diff --git a/lib/Api/ManageWebhooksApi.php b/lib/Api/ManageWebhooksApi.php index 78aae9f35..99120cd0b 100644 --- a/lib/Api/ManageWebhooksApi.php +++ b/lib/Api/ManageWebhooksApi.php @@ -129,7 +129,6 @@ public function deleteWebhookSubscriptionWithHttpInfo($webhookId) self::$logger->error("InvalidArgumentException : Missing the required parameter $webhookId when calling deleteWebhookSubscription"); throw new \InvalidArgumentException('Missing the required parameter $webhookId when calling deleteWebhookSubscription'); } - // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks/{webhookId}"; $httpBody = ''; @@ -234,7 +233,6 @@ public function getWebhookSubscriptionByIdWithHttpInfo($webhookId) self::$logger->error("InvalidArgumentException : Missing the required parameter $webhookId when calling getWebhookSubscriptionById"); throw new \InvalidArgumentException('Missing the required parameter $webhookId when calling getWebhookSubscriptionById'); } - // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks/{webhookId}"; $httpBody = ''; @@ -347,19 +345,16 @@ public function getWebhookSubscriptionsByOrgWithHttpInfo($organizationId, $produ self::$logger->error("InvalidArgumentException : Missing the required parameter $organizationId when calling getWebhookSubscriptionsByOrg"); throw new \InvalidArgumentException('Missing the required parameter $organizationId when calling getWebhookSubscriptionsByOrg'); } - // verify the required parameter 'productId' is set if ($productId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $productId when calling getWebhookSubscriptionsByOrg"); throw new \InvalidArgumentException('Missing the required parameter $productId when calling getWebhookSubscriptionsByOrg'); } - // verify the required parameter 'eventType' is set if ($eventType === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $eventType when calling getWebhookSubscriptionsByOrg"); throw new \InvalidArgumentException('Missing the required parameter $eventType when calling getWebhookSubscriptionsByOrg'); } - // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks"; $httpBody = ''; @@ -481,20 +476,16 @@ public function saveAsymEgressKeyWithHttpInfo($vCSenderOrganizationId, $vCPermis self::$logger->error("InvalidArgumentException : Missing the required parameter $vCSenderOrganizationId when calling saveAsymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $vCSenderOrganizationId when calling saveAsymEgressKey'); } - // verify the required parameter 'vCPermissions' is set if ($vCPermissions === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCPermissions when calling saveAsymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $vCPermissions when calling saveAsymEgressKey'); } - // verify the required parameter 'saveAsymEgressKey' is set if ($saveAsymEgressKey === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $saveAsymEgressKey when calling saveAsymEgressKey"); throw new \InvalidArgumentException('Missing the required parameter $saveAsymEgressKey when calling saveAsymEgressKey'); } - - // parse inputs $resourcePath = "/kms/egress/v2/keys-asym"; $httpBody = ''; @@ -616,8 +607,6 @@ public function updateWebhookSubscriptionWithHttpInfo($webhookId, $updateWebhook self::$logger->error("InvalidArgumentException : Missing the required parameter $webhookId when calling updateWebhookSubscription"); throw new \InvalidArgumentException('Missing the required parameter $webhookId when calling updateWebhookSubscription'); } - - // parse inputs $resourcePath = "/notification-subscriptions/v1/webhooks/{webhookId}"; $httpBody = ''; diff --git a/lib/Api/MerchantBoardingApi.php b/lib/Api/MerchantBoardingApi.php index c0aa8e60a..8ccbd3f5e 100644 --- a/lib/Api/MerchantBoardingApi.php +++ b/lib/Api/MerchantBoardingApi.php @@ -129,7 +129,6 @@ public function getRegistrationWithHttpInfo($registrationId) self::$logger->error("InvalidArgumentException : Missing the required parameter $registrationId when calling getRegistration"); throw new \InvalidArgumentException('Missing the required parameter $registrationId when calling getRegistration'); } - // parse inputs $resourcePath = "/boarding/v1/registrations/{registrationId}"; $httpBody = ''; @@ -252,8 +251,6 @@ public function postRegistrationWithHttpInfo($postRegistrationBody, $vCIdempoten self::$logger->error("InvalidArgumentException : Missing the required parameter $postRegistrationBody when calling postRegistration"); throw new \InvalidArgumentException('Missing the required parameter $postRegistrationBody when calling postRegistration'); } - - // parse inputs $resourcePath = "/boarding/v1/registrations"; $httpBody = ''; diff --git a/lib/Api/MicroformIntegrationApi.php b/lib/Api/MicroformIntegrationApi.php index 28b1f652e..ae8182032 100644 --- a/lib/Api/MicroformIntegrationApi.php +++ b/lib/Api/MicroformIntegrationApi.php @@ -127,7 +127,6 @@ public function generateCaptureContextWithHttpInfo($generateCaptureContextReques self::$logger->error("InvalidArgumentException : Missing the required parameter $generateCaptureContextRequest when calling generateCaptureContext"); throw new \InvalidArgumentException('Missing the required parameter $generateCaptureContextRequest when calling generateCaptureContext'); } - // parse inputs $resourcePath = "/microform/v2/sessions"; $httpBody = ''; diff --git a/lib/Api/NetFundingsApi.php b/lib/Api/NetFundingsApi.php index 4915547ec..7f83be553 100644 --- a/lib/Api/NetFundingsApi.php +++ b/lib/Api/NetFundingsApi.php @@ -133,15 +133,11 @@ public function getNetFundingDetailsWithHttpInfo($startTime, $endTime, $organiza self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getNetFundingDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getNetFundingDetails'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getNetFundingDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getNetFundingDetails'); } - - - // parse inputs $resourcePath = "/reporting/v3/net-fundings"; $httpBody = ''; diff --git a/lib/Api/NotificationOfChangesApi.php b/lib/Api/NotificationOfChangesApi.php index 5fdb3443c..1855e39a5 100644 --- a/lib/Api/NotificationOfChangesApi.php +++ b/lib/Api/NotificationOfChangesApi.php @@ -129,13 +129,11 @@ public function getNotificationOfChangeReportWithHttpInfo($startTime, $endTime) self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getNotificationOfChangeReport"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getNotificationOfChangeReport'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getNotificationOfChangeReport"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getNotificationOfChangeReport'); } - // parse inputs $resourcePath = "/reporting/v3/notification-of-changes"; $httpBody = ''; diff --git a/lib/Api/PayerAuthenticationApi.php b/lib/Api/PayerAuthenticationApi.php index 10c36c063..dcb153fce 100644 --- a/lib/Api/PayerAuthenticationApi.php +++ b/lib/Api/PayerAuthenticationApi.php @@ -127,7 +127,6 @@ public function checkPayerAuthEnrollmentWithHttpInfo($checkPayerAuthEnrollmentRe self::$logger->error("InvalidArgumentException : Missing the required parameter $checkPayerAuthEnrollmentRequest when calling checkPayerAuthEnrollment"); throw new \InvalidArgumentException('Missing the required parameter $checkPayerAuthEnrollmentRequest when calling checkPayerAuthEnrollment'); } - // parse inputs $resourcePath = "/risk/v1/authentications"; $httpBody = ''; @@ -241,7 +240,6 @@ public function payerAuthSetupWithHttpInfo($payerAuthSetupRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $payerAuthSetupRequest when calling payerAuthSetup"); throw new \InvalidArgumentException('Missing the required parameter $payerAuthSetupRequest when calling payerAuthSetup'); } - // parse inputs $resourcePath = "/risk/v1/authentication-setups"; $httpBody = ''; @@ -355,7 +353,6 @@ public function validateAuthenticationResultsWithHttpInfo($validateRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $validateRequest when calling validateAuthenticationResults"); throw new \InvalidArgumentException('Missing the required parameter $validateRequest when calling validateAuthenticationResults'); } - // parse inputs $resourcePath = "/risk/v1/authentication-results"; $httpBody = ''; diff --git a/lib/Api/PaymentBatchSummariesApi.php b/lib/Api/PaymentBatchSummariesApi.php index 7f492bdba..b47e8ccc7 100644 --- a/lib/Api/PaymentBatchSummariesApi.php +++ b/lib/Api/PaymentBatchSummariesApi.php @@ -137,17 +137,11 @@ public function getPaymentBatchSummaryWithHttpInfo($startTime, $endTime, $organi self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getPaymentBatchSummary"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getPaymentBatchSummary'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getPaymentBatchSummary"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getPaymentBatchSummary'); } - - - - - // parse inputs $resourcePath = "/reporting/v3/payment-batch-summaries"; $httpBody = ''; diff --git a/lib/Api/PaymentInstrumentApi.php b/lib/Api/PaymentInstrumentApi.php index 25396ac96..69893902b 100644 --- a/lib/Api/PaymentInstrumentApi.php +++ b/lib/Api/PaymentInstrumentApi.php @@ -129,8 +129,6 @@ public function deletePaymentInstrumentWithHttpInfo($paymentInstrumentId, $profi self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling deletePaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling deletePaymentInstrument'); } - - // parse inputs $resourcePath = "/tms/v1/paymentinstruments/{paymentInstrumentId}"; $httpBody = ''; @@ -259,8 +257,6 @@ public function getPaymentInstrumentWithHttpInfo($paymentInstrumentId, $profileI self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling getPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling getPaymentInstrument'); } - - // parse inputs $resourcePath = "/tms/v1/paymentinstruments/{paymentInstrumentId}"; $httpBody = ''; @@ -401,15 +397,11 @@ public function patchPaymentInstrumentWithHttpInfo($paymentInstrumentId, $patchP self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentInstrumentId when calling patchPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $paymentInstrumentId when calling patchPaymentInstrument'); } - // verify the required parameter 'patchPaymentInstrumentRequest' is set if ($patchPaymentInstrumentRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $patchPaymentInstrumentRequest when calling patchPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $patchPaymentInstrumentRequest when calling patchPaymentInstrument'); } - - - // parse inputs $resourcePath = "/tms/v1/paymentinstruments/{paymentInstrumentId}"; $httpBody = ''; @@ -561,8 +553,6 @@ public function postPaymentInstrumentWithHttpInfo($postPaymentInstrumentRequest, self::$logger->error("InvalidArgumentException : Missing the required parameter $postPaymentInstrumentRequest when calling postPaymentInstrument"); throw new \InvalidArgumentException('Missing the required parameter $postPaymentInstrumentRequest when calling postPaymentInstrument'); } - - // parse inputs $resourcePath = "/tms/v1/paymentinstruments"; $httpBody = ''; diff --git a/lib/Api/PaymentsApi.php b/lib/Api/PaymentsApi.php index b6562c659..60d9c6d1d 100644 --- a/lib/Api/PaymentsApi.php +++ b/lib/Api/PaymentsApi.php @@ -129,13 +129,11 @@ public function createOrderRequestWithHttpInfo($orderPaymentRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $orderPaymentRequest when calling createOrderRequest"); throw new \InvalidArgumentException('Missing the required parameter $orderPaymentRequest when calling createOrderRequest'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling createOrderRequest"); throw new \InvalidArgumentException('Missing the required parameter $id when calling createOrderRequest'); } - // parse inputs $resourcePath = "/pts/v2/payment-references/{id}/intents"; $httpBody = ''; @@ -257,7 +255,6 @@ public function createPaymentWithHttpInfo($createPaymentRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createPaymentRequest when calling createPayment"); throw new \InvalidArgumentException('Missing the required parameter $createPaymentRequest when calling createPayment'); } - // parse inputs $resourcePath = "/pts/v2/payments"; $httpBody = ''; @@ -371,7 +368,6 @@ public function createSessionRequestWithHttpInfo($createSessionReq) self::$logger->error("InvalidArgumentException : Missing the required parameter $createSessionReq when calling createSessionRequest"); throw new \InvalidArgumentException('Missing the required parameter $createSessionReq when calling createSessionRequest'); } - // parse inputs $resourcePath = "/pts/v2/payment-references"; $httpBody = ''; @@ -487,13 +483,11 @@ public function incrementAuthWithHttpInfo($id, $incrementAuthRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling incrementAuth"); throw new \InvalidArgumentException('Missing the required parameter $id when calling incrementAuth'); } - // verify the required parameter 'incrementAuthRequest' is set if ($incrementAuthRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $incrementAuthRequest when calling incrementAuth"); throw new \InvalidArgumentException('Missing the required parameter $incrementAuthRequest when calling incrementAuth'); } - // parse inputs $resourcePath = "/pts/v2/payments/{id}"; $httpBody = ''; @@ -617,13 +611,11 @@ public function refreshPaymentStatusWithHttpInfo($id, $refreshPaymentStatusReque self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling refreshPaymentStatus"); throw new \InvalidArgumentException('Missing the required parameter $id when calling refreshPaymentStatus'); } - // verify the required parameter 'refreshPaymentStatusRequest' is set if ($refreshPaymentStatusRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $refreshPaymentStatusRequest when calling refreshPaymentStatus"); throw new \InvalidArgumentException('Missing the required parameter $refreshPaymentStatusRequest when calling refreshPaymentStatus'); } - // parse inputs $resourcePath = "/pts/v2/refresh-payment-status/{id}"; $httpBody = ''; @@ -747,13 +739,11 @@ public function updateSessionReqWithHttpInfo($createSessionRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $createSessionRequest when calling updateSessionReq"); throw new \InvalidArgumentException('Missing the required parameter $createSessionRequest when calling updateSessionReq'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling updateSessionReq"); throw new \InvalidArgumentException('Missing the required parameter $id when calling updateSessionReq'); } - // parse inputs $resourcePath = "/pts/v2/payment-references/{id}"; $httpBody = ''; diff --git a/lib/Api/PayoutsApi.php b/lib/Api/PayoutsApi.php index 8327765ce..1a1d4cfda 100644 --- a/lib/Api/PayoutsApi.php +++ b/lib/Api/PayoutsApi.php @@ -127,7 +127,6 @@ public function octCreatePaymentWithHttpInfo($octCreatePaymentRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $octCreatePaymentRequest when calling octCreatePayment"); throw new \InvalidArgumentException('Missing the required parameter $octCreatePaymentRequest when calling octCreatePayment'); } - // parse inputs $resourcePath = "/pts/v2/payouts"; $httpBody = ''; diff --git a/lib/Api/PlansApi.php b/lib/Api/PlansApi.php index fd92d2483..0d9557827 100644 --- a/lib/Api/PlansApi.php +++ b/lib/Api/PlansApi.php @@ -127,7 +127,6 @@ public function activatePlanWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling activatePlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling activatePlan'); } - // parse inputs $resourcePath = "/rbs/v1/plans/{id}/activate"; $httpBody = ''; @@ -246,7 +245,6 @@ public function createPlanWithHttpInfo($createPlanRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createPlanRequest when calling createPlan"); throw new \InvalidArgumentException('Missing the required parameter $createPlanRequest when calling createPlan'); } - // parse inputs $resourcePath = "/rbs/v1/plans"; $httpBody = ''; @@ -360,7 +358,6 @@ public function deactivatePlanWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling deactivatePlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling deactivatePlan'); } - // parse inputs $resourcePath = "/rbs/v1/plans/{id}/deactivate"; $httpBody = ''; @@ -479,7 +476,6 @@ public function deletePlanWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling deletePlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling deletePlan'); } - // parse inputs $resourcePath = "/rbs/v1/plans/{id}"; $httpBody = ''; @@ -598,7 +594,6 @@ public function getPlanWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getPlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getPlan'); } - // parse inputs $resourcePath = "/rbs/v1/plans/{id}"; $httpBody = ''; @@ -819,11 +814,6 @@ public function getPlans($offset = null, $limit = null, $code = null, $status = */ public function getPlansWithHttpInfo($offset = null, $limit = null, $code = null, $status = null, $name = null) { - - - - - // parse inputs $resourcePath = "/rbs/v1/plans"; $httpBody = ''; @@ -957,13 +947,11 @@ public function updatePlanWithHttpInfo($id, $updatePlanRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling updatePlan"); throw new \InvalidArgumentException('Missing the required parameter $id when calling updatePlan'); } - // verify the required parameter 'updatePlanRequest' is set if ($updatePlanRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updatePlanRequest when calling updatePlan"); throw new \InvalidArgumentException('Missing the required parameter $updatePlanRequest when calling updatePlan'); } - // parse inputs $resourcePath = "/rbs/v1/plans/{id}"; $httpBody = ''; diff --git a/lib/Api/PurchaseAndRefundDetailsApi.php b/lib/Api/PurchaseAndRefundDetailsApi.php index 344652f88..cf9f76875 100644 --- a/lib/Api/PurchaseAndRefundDetailsApi.php +++ b/lib/Api/PurchaseAndRefundDetailsApi.php @@ -141,19 +141,11 @@ public function getPurchaseAndRefundDetailsWithHttpInfo($startTime, $endTime, $o self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getPurchaseAndRefundDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getPurchaseAndRefundDetails'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getPurchaseAndRefundDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getPurchaseAndRefundDetails'); } - - - - - - - // parse inputs $resourcePath = "/reporting/v3/purchase-refund-details"; $httpBody = ''; diff --git a/lib/Api/PushFundsApi.php b/lib/Api/PushFundsApi.php index a6cd2bc3f..0efb5449d 100644 --- a/lib/Api/PushFundsApi.php +++ b/lib/Api/PushFundsApi.php @@ -139,43 +139,36 @@ public function createPushFundsTransferWithHttpInfo($pushFundsRequest, $contentT self::$logger->error("InvalidArgumentException : Missing the required parameter $pushFundsRequest when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $pushFundsRequest when calling createPushFundsTransfer'); } - // verify the required parameter 'contentType' is set if ($contentType === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $contentType when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $contentType when calling createPushFundsTransfer'); } - // verify the required parameter 'xRequestid' is set if ($xRequestid === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $xRequestid when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $xRequestid when calling createPushFundsTransfer'); } - // verify the required parameter 'vCMerchantId' is set if ($vCMerchantId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCMerchantId when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $vCMerchantId when calling createPushFundsTransfer'); } - // verify the required parameter 'vCPermissions' is set if ($vCPermissions === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCPermissions when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $vCPermissions when calling createPushFundsTransfer'); } - // verify the required parameter 'vCCorrelationId' is set if ($vCCorrelationId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCCorrelationId when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $vCCorrelationId when calling createPushFundsTransfer'); } - // verify the required parameter 'vCOrganizationId' is set if ($vCOrganizationId === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $vCOrganizationId when calling createPushFundsTransfer"); throw new \InvalidArgumentException('Missing the required parameter $vCOrganizationId when calling createPushFundsTransfer'); } - // parse inputs $resourcePath = "/pts/v1/push-funds-transfer"; $httpBody = ''; diff --git a/lib/Api/RefundApi.php b/lib/Api/RefundApi.php index 25e431556..3ddd5162b 100644 --- a/lib/Api/RefundApi.php +++ b/lib/Api/RefundApi.php @@ -129,13 +129,11 @@ public function refundCaptureWithHttpInfo($refundCaptureRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $refundCaptureRequest when calling refundCapture"); throw new \InvalidArgumentException('Missing the required parameter $refundCaptureRequest when calling refundCapture'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling refundCapture"); throw new \InvalidArgumentException('Missing the required parameter $id when calling refundCapture'); } - // parse inputs $resourcePath = "/pts/v2/captures/{id}/refunds"; $httpBody = ''; @@ -259,13 +257,11 @@ public function refundPaymentWithHttpInfo($refundPaymentRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $refundPaymentRequest when calling refundPayment"); throw new \InvalidArgumentException('Missing the required parameter $refundPaymentRequest when calling refundPayment'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling refundPayment"); throw new \InvalidArgumentException('Missing the required parameter $id when calling refundPayment'); } - // parse inputs $resourcePath = "/pts/v2/payments/{id}/refunds"; $httpBody = ''; diff --git a/lib/Api/ReplayWebhooksApi.php b/lib/Api/ReplayWebhooksApi.php index b8ca3b472..955753d5d 100644 --- a/lib/Api/ReplayWebhooksApi.php +++ b/lib/Api/ReplayWebhooksApi.php @@ -131,8 +131,6 @@ public function replayPreviousWebhooksWithHttpInfo($webhookId, $replayWebhooksRe self::$logger->error("InvalidArgumentException : Missing the required parameter $webhookId when calling replayPreviousWebhooks"); throw new \InvalidArgumentException('Missing the required parameter $webhookId when calling replayPreviousWebhooks'); } - - // parse inputs $resourcePath = "/nrtf/v1/webhooks/{webhookId}/replays"; $httpBody = ''; diff --git a/lib/Api/ReportDefinitionsApi.php b/lib/Api/ReportDefinitionsApi.php index baf845296..c8f7a8563 100644 --- a/lib/Api/ReportDefinitionsApi.php +++ b/lib/Api/ReportDefinitionsApi.php @@ -133,10 +133,6 @@ public function getResourceInfoByReportDefinitionWithHttpInfo($reportDefinitionN self::$logger->error("InvalidArgumentException : Missing the required parameter $reportDefinitionName when calling getResourceInfoByReportDefinition"); throw new \InvalidArgumentException('Missing the required parameter $reportDefinitionName when calling getResourceInfoByReportDefinition'); } - - - - // parse inputs $resourcePath = "/reporting/v3/report-definitions/{reportDefinitionName}"; $httpBody = ''; @@ -259,8 +255,6 @@ public function getResourceV2Info($subscriptionType = null, $organizationId = nu */ public function getResourceV2InfoWithHttpInfo($subscriptionType = null, $organizationId = null) { - - // parse inputs $resourcePath = "/reporting/v3/report-definitions"; $httpBody = ''; diff --git a/lib/Api/ReportDownloadsApi.php b/lib/Api/ReportDownloadsApi.php index 9cd3fa2a7..fc1e29a7f 100644 --- a/lib/Api/ReportDownloadsApi.php +++ b/lib/Api/ReportDownloadsApi.php @@ -131,14 +131,11 @@ public function downloadReportWithHttpInfo($reportDate, $reportName, $organizati self::$logger->error("InvalidArgumentException : Missing the required parameter $reportDate when calling downloadReport"); throw new \InvalidArgumentException('Missing the required parameter $reportDate when calling downloadReport'); } - // verify the required parameter 'reportName' is set if ($reportName === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $reportName when calling downloadReport"); throw new \InvalidArgumentException('Missing the required parameter $reportName when calling downloadReport'); } - - // parse inputs $resourcePath = "/reporting/v3/report-downloads"; $httpBody = ''; diff --git a/lib/Api/ReportSubscriptionsApi.php b/lib/Api/ReportSubscriptionsApi.php index e69dcadac..740e34ea6 100644 --- a/lib/Api/ReportSubscriptionsApi.php +++ b/lib/Api/ReportSubscriptionsApi.php @@ -129,8 +129,6 @@ public function createStandardOrClassicSubscriptionWithHttpInfo($predefinedSubsc self::$logger->error("InvalidArgumentException : Missing the required parameter $predefinedSubscriptionRequestBean when calling createStandardOrClassicSubscription"); throw new \InvalidArgumentException('Missing the required parameter $predefinedSubscriptionRequestBean when calling createStandardOrClassicSubscription'); } - - // parse inputs $resourcePath = "/reporting/v3/predefined-report-subscriptions"; $httpBody = ''; @@ -243,8 +241,6 @@ public function createSubscriptionWithHttpInfo($createReportSubscriptionRequest, self::$logger->error("InvalidArgumentException : Missing the required parameter $createReportSubscriptionRequest when calling createSubscription"); throw new \InvalidArgumentException('Missing the required parameter $createReportSubscriptionRequest when calling createSubscription'); } - - // parse inputs $resourcePath = "/reporting/v3/report-subscriptions"; $httpBody = ''; @@ -357,8 +353,6 @@ public function deleteSubscriptionWithHttpInfo($reportName, $organizationId = nu self::$logger->error("InvalidArgumentException : Missing the required parameter $reportName when calling deleteSubscription"); throw new \InvalidArgumentException('Missing the required parameter $reportName when calling deleteSubscription'); } - - // parse inputs $resourcePath = "/reporting/v3/report-subscriptions/{reportName}"; $httpBody = ''; @@ -469,7 +463,6 @@ public function getAllSubscriptions($organizationId = null) */ public function getAllSubscriptionsWithHttpInfo($organizationId = null) { - // parse inputs $resourcePath = "/reporting/v3/report-subscriptions"; $httpBody = ''; @@ -579,8 +572,6 @@ public function getSubscriptionWithHttpInfo($reportName, $organizationId = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $reportName when calling getSubscription"); throw new \InvalidArgumentException('Missing the required parameter $reportName when calling getSubscription'); } - - // parse inputs $resourcePath = "/reporting/v3/report-subscriptions/{reportName}"; $httpBody = ''; diff --git a/lib/Api/ReportsApi.php b/lib/Api/ReportsApi.php index 9969f0cdc..9520a5c47 100644 --- a/lib/Api/ReportsApi.php +++ b/lib/Api/ReportsApi.php @@ -129,8 +129,6 @@ public function createReportWithHttpInfo($createAdhocReportRequest, $organizatio self::$logger->error("InvalidArgumentException : Missing the required parameter $createAdhocReportRequest when calling createReport"); throw new \InvalidArgumentException('Missing the required parameter $createAdhocReportRequest when calling createReport'); } - - // parse inputs $resourcePath = "/reporting/v3/reports"; $httpBody = ''; @@ -243,8 +241,6 @@ public function getReportByReportIdWithHttpInfo($reportId, $organizationId = nul self::$logger->error("InvalidArgumentException : Missing the required parameter $reportId when calling getReportByReportId"); throw new \InvalidArgumentException('Missing the required parameter $reportId when calling getReportByReportId'); } - - // parse inputs $resourcePath = "/reporting/v3/reports/{reportId}"; $httpBody = ''; @@ -376,25 +372,16 @@ public function searchReportsWithHttpInfo($startTime, $endTime, $timeQueryType, self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling searchReports"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling searchReports'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling searchReports"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling searchReports'); } - // verify the required parameter 'timeQueryType' is set if ($timeQueryType === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $timeQueryType when calling searchReports"); throw new \InvalidArgumentException('Missing the required parameter $timeQueryType when calling searchReports'); } - - - - - - - // parse inputs $resourcePath = "/reporting/v3/reports"; $httpBody = ''; diff --git a/lib/Api/RetrievalDetailsApi.php b/lib/Api/RetrievalDetailsApi.php index 70a3b1e68..e1db8a03a 100644 --- a/lib/Api/RetrievalDetailsApi.php +++ b/lib/Api/RetrievalDetailsApi.php @@ -131,14 +131,11 @@ public function getRetrievalDetailsWithHttpInfo($startTime, $endTime, $organizat self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getRetrievalDetails"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getRetrievalDetails'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getRetrievalDetails"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getRetrievalDetails'); } - - // parse inputs $resourcePath = "/reporting/v3/retrieval-details"; $httpBody = ''; diff --git a/lib/Api/RetrievalSummariesApi.php b/lib/Api/RetrievalSummariesApi.php index 84ca19f15..da5ec3c16 100644 --- a/lib/Api/RetrievalSummariesApi.php +++ b/lib/Api/RetrievalSummariesApi.php @@ -131,14 +131,11 @@ public function getRetrievalSummaryWithHttpInfo($startTime, $endTime, $organizat self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getRetrievalSummary"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getRetrievalSummary'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getRetrievalSummary"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getRetrievalSummary'); } - - // parse inputs $resourcePath = "/reporting/v3/retrieval-summaries"; $httpBody = ''; diff --git a/lib/Api/ReversalApi.php b/lib/Api/ReversalApi.php index e0c88aaee..2295d533b 100644 --- a/lib/Api/ReversalApi.php +++ b/lib/Api/ReversalApi.php @@ -129,13 +129,11 @@ public function authReversalWithHttpInfo($id, $authReversalRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling authReversal"); throw new \InvalidArgumentException('Missing the required parameter $id when calling authReversal'); } - // verify the required parameter 'authReversalRequest' is set if ($authReversalRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $authReversalRequest when calling authReversal"); throw new \InvalidArgumentException('Missing the required parameter $authReversalRequest when calling authReversal'); } - // parse inputs $resourcePath = "/pts/v2/payments/{id}/reversals"; $httpBody = ''; @@ -257,7 +255,6 @@ public function mitReversalWithHttpInfo($mitReversalRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $mitReversalRequest when calling mitReversal"); throw new \InvalidArgumentException('Missing the required parameter $mitReversalRequest when calling mitReversal'); } - // parse inputs $resourcePath = "/pts/v2/reversals"; $httpBody = ''; diff --git a/lib/Api/SearchTransactionsApi.php b/lib/Api/SearchTransactionsApi.php index 70138cfbb..01713327b 100644 --- a/lib/Api/SearchTransactionsApi.php +++ b/lib/Api/SearchTransactionsApi.php @@ -127,7 +127,6 @@ public function createSearchWithHttpInfo($createSearchRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createSearchRequest when calling createSearch"); throw new \InvalidArgumentException('Missing the required parameter $createSearchRequest when calling createSearch'); } - // parse inputs $resourcePath = "/tss/v2/searches"; $httpBody = ''; @@ -241,7 +240,6 @@ public function getSearchWithHttpInfo($searchId) self::$logger->error("InvalidArgumentException : Missing the required parameter $searchId when calling getSearch"); throw new \InvalidArgumentException('Missing the required parameter $searchId when calling getSearch'); } - // parse inputs $resourcePath = "/tss/v2/searches/{searchId}"; $httpBody = ''; diff --git a/lib/Api/SecureFileShareApi.php b/lib/Api/SecureFileShareApi.php index 5fbf3c2ba..92aa2323f 100644 --- a/lib/Api/SecureFileShareApi.php +++ b/lib/Api/SecureFileShareApi.php @@ -129,8 +129,6 @@ public function getFileWithHttpInfo($fileId, $organizationId = null) self::$logger->error("InvalidArgumentException : Missing the required parameter $fileId when calling getFile"); throw new \InvalidArgumentException('Missing the required parameter $fileId when calling getFile'); } - - // parse inputs $resourcePath = "/sfs/v1/files/{fileId}"; $httpBody = ''; @@ -248,15 +246,11 @@ public function getFileDetailWithHttpInfo($startDate, $endDate, $organizationId self::$logger->error("InvalidArgumentException : Missing the required parameter $startDate when calling getFileDetail"); throw new \InvalidArgumentException('Missing the required parameter $startDate when calling getFileDetail'); } - // verify the required parameter 'endDate' is set if ($endDate === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endDate when calling getFileDetail"); throw new \InvalidArgumentException('Missing the required parameter $endDate when calling getFileDetail'); } - - - // parse inputs $resourcePath = "/sfs/v1/file-details"; $httpBody = ''; diff --git a/lib/Api/SubscriptionsApi.php b/lib/Api/SubscriptionsApi.php index 767f67bc0..5630a8ef4 100644 --- a/lib/Api/SubscriptionsApi.php +++ b/lib/Api/SubscriptionsApi.php @@ -127,7 +127,6 @@ public function activateSubscriptionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling activateSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling activateSubscription'); } - // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}/activate"; $httpBody = ''; @@ -246,7 +245,6 @@ public function cancelSubscriptionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling cancelSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling cancelSubscription'); } - // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}/cancel"; $httpBody = ''; @@ -365,7 +363,6 @@ public function createSubscriptionWithHttpInfo($createSubscriptionRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $createSubscriptionRequest when calling createSubscription"); throw new \InvalidArgumentException('Missing the required parameter $createSubscriptionRequest when calling createSubscription'); } - // parse inputs $resourcePath = "/rbs/v1/subscriptions"; $httpBody = ''; @@ -480,10 +477,6 @@ public function getAllSubscriptions($offset = null, $limit = null, $code = null, */ public function getAllSubscriptionsWithHttpInfo($offset = null, $limit = null, $code = null, $status = null) { - - - - // parse inputs $resourcePath = "/rbs/v1/subscriptions"; $httpBody = ''; @@ -610,7 +603,6 @@ public function getSubscriptionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getSubscription'); } - // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}"; $httpBody = ''; @@ -828,7 +820,6 @@ public function suspendSubscriptionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling suspendSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling suspendSubscription'); } - // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}/suspend"; $httpBody = ''; @@ -949,13 +940,11 @@ public function updateSubscriptionWithHttpInfo($id, $updateSubscription) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling updateSubscription"); throw new \InvalidArgumentException('Missing the required parameter $id when calling updateSubscription'); } - // verify the required parameter 'updateSubscription' is set if ($updateSubscription === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $updateSubscription when calling updateSubscription"); throw new \InvalidArgumentException('Missing the required parameter $updateSubscription when calling updateSubscription'); } - // parse inputs $resourcePath = "/rbs/v1/subscriptions/{id}"; $httpBody = ''; diff --git a/lib/Api/SymmetricKeyManagementApi.php b/lib/Api/SymmetricKeyManagementApi.php index 28f30e92e..63f9040ab 100644 --- a/lib/Api/SymmetricKeyManagementApi.php +++ b/lib/Api/SymmetricKeyManagementApi.php @@ -127,7 +127,6 @@ public function createV2SharedSecretKeysWithHttpInfo($createSharedSecretKeysRequ self::$logger->error("InvalidArgumentException : Missing the required parameter $createSharedSecretKeysRequest when calling createV2SharedSecretKeys"); throw new \InvalidArgumentException('Missing the required parameter $createSharedSecretKeysRequest when calling createV2SharedSecretKeys'); } - // parse inputs $resourcePath = "/kms/v2/keys-sym"; $httpBody = ''; @@ -243,13 +242,11 @@ public function createV2SharedSecretKeysVerifiWithHttpInfo($vIcDomain, $createSh self::$logger->error("InvalidArgumentException : Missing the required parameter $vIcDomain when calling createV2SharedSecretKeysVerifi"); throw new \InvalidArgumentException('Missing the required parameter $vIcDomain when calling createV2SharedSecretKeysVerifi'); } - // verify the required parameter 'createSharedSecretKeysVerifiRequest' is set if ($createSharedSecretKeysVerifiRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $createSharedSecretKeysVerifiRequest when calling createV2SharedSecretKeysVerifi"); throw new \InvalidArgumentException('Missing the required parameter $createSharedSecretKeysVerifiRequest when calling createV2SharedSecretKeysVerifi'); } - // parse inputs $resourcePath = "/kms/v2/keys-sym/verifi"; $httpBody = ''; @@ -367,7 +364,6 @@ public function deleteBulkSymmetricKeysWithHttpInfo($deleteBulkSymmetricKeysRequ self::$logger->error("InvalidArgumentException : Missing the required parameter $deleteBulkSymmetricKeysRequest when calling deleteBulkSymmetricKeys"); throw new \InvalidArgumentException('Missing the required parameter $deleteBulkSymmetricKeysRequest when calling deleteBulkSymmetricKeys'); } - // parse inputs $resourcePath = "/kms/v2/keys-sym/deletes"; $httpBody = ''; @@ -481,7 +477,6 @@ public function getKeyDetailsWithHttpInfo($keyId) self::$logger->error("InvalidArgumentException : Missing the required parameter $keyId when calling getKeyDetails"); throw new \InvalidArgumentException('Missing the required parameter $keyId when calling getKeyDetails'); } - // parse inputs $resourcePath = "/kms/v2/keys-sym/{keyId}"; $httpBody = ''; diff --git a/lib/Api/TaxesApi.php b/lib/Api/TaxesApi.php index d94fbb8c9..11ae5d063 100644 --- a/lib/Api/TaxesApi.php +++ b/lib/Api/TaxesApi.php @@ -127,7 +127,6 @@ public function calculateTaxWithHttpInfo($taxRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $taxRequest when calling calculateTax"); throw new \InvalidArgumentException('Missing the required parameter $taxRequest when calling calculateTax'); } - // parse inputs $resourcePath = "/vas/v2/tax"; $httpBody = ''; @@ -243,13 +242,11 @@ public function voidTaxWithHttpInfo($voidTaxRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidTaxRequest when calling voidTax"); throw new \InvalidArgumentException('Missing the required parameter $voidTaxRequest when calling voidTax'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidTax"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidTax'); } - // parse inputs $resourcePath = "/vas/v2/tax/{id}"; $httpBody = ''; diff --git a/lib/Api/TokenApi.php b/lib/Api/TokenApi.php index f89305fff..581567019 100644 --- a/lib/Api/TokenApi.php +++ b/lib/Api/TokenApi.php @@ -131,14 +131,11 @@ public function postTokenPaymentCredentialsWithHttpInfo($tokenId, $postPaymentCr self::$logger->error("InvalidArgumentException : Missing the required parameter $tokenId when calling postTokenPaymentCredentials"); throw new \InvalidArgumentException('Missing the required parameter $tokenId when calling postTokenPaymentCredentials'); } - // verify the required parameter 'postPaymentCredentialsRequest' is set if ($postPaymentCredentialsRequest === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $postPaymentCredentialsRequest when calling postTokenPaymentCredentials"); throw new \InvalidArgumentException('Missing the required parameter $postPaymentCredentialsRequest when calling postTokenPaymentCredentials'); } - - // parse inputs $resourcePath = "/tms/v2/tokens/{tokenId}/payment-credentials"; $httpBody = ''; diff --git a/lib/Api/TransactionBatchesApi.php b/lib/Api/TransactionBatchesApi.php index 959d4d218..643e94e02 100644 --- a/lib/Api/TransactionBatchesApi.php +++ b/lib/Api/TransactionBatchesApi.php @@ -131,9 +131,6 @@ public function getTransactionBatchDetailsWithHttpInfo($id, $uploadDate = null, self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getTransactionBatchDetails"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getTransactionBatchDetails'); } - - - // parse inputs $resourcePath = "/pts/v1/transaction-batch-details/{id}"; $httpBody = ''; @@ -266,7 +263,6 @@ public function getTransactionBatchIdWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getTransactionBatchId"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getTransactionBatchId'); } - // parse inputs $resourcePath = "/pts/v1/transaction-batches/{id}"; $httpBody = ''; @@ -395,13 +391,11 @@ public function getTransactionBatchesWithHttpInfo($startTime, $endTime) self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getTransactionBatches"); throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getTransactionBatches'); } - // verify the required parameter 'endTime' is set if ($endTime === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getTransactionBatches"); throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getTransactionBatches'); } - // parse inputs $resourcePath = "/pts/v1/transaction-batches"; $httpBody = ''; diff --git a/lib/Api/TransactionDetailsApi.php b/lib/Api/TransactionDetailsApi.php index 711fa39a4..61fbe30b1 100644 --- a/lib/Api/TransactionDetailsApi.php +++ b/lib/Api/TransactionDetailsApi.php @@ -127,7 +127,6 @@ public function getTransactionWithHttpInfo($id) self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling getTransaction"); throw new \InvalidArgumentException('Missing the required parameter $id when calling getTransaction'); } - // parse inputs $resourcePath = "/tss/v2/transactions/{id}"; $httpBody = ''; diff --git a/lib/Api/TransientTokenDataApi.php b/lib/Api/TransientTokenDataApi.php index 43b439089..42122cafa 100644 --- a/lib/Api/TransientTokenDataApi.php +++ b/lib/Api/TransientTokenDataApi.php @@ -127,7 +127,6 @@ public function getPaymentCredentialsForTransientTokenWithHttpInfo($paymentCrede self::$logger->error("InvalidArgumentException : Missing the required parameter $paymentCredentialsReference when calling getPaymentCredentialsForTransientToken"); throw new \InvalidArgumentException('Missing the required parameter $paymentCredentialsReference when calling getPaymentCredentialsForTransientToken'); } - // parse inputs $resourcePath = "/flex/v2/payment-credentials/{paymentCredentialsReference}"; $httpBody = ''; @@ -234,7 +233,6 @@ public function getTransactionForTransientTokenWithHttpInfo($transientToken) self::$logger->error("InvalidArgumentException : Missing the required parameter $transientToken when calling getTransactionForTransientToken"); throw new \InvalidArgumentException('Missing the required parameter $transientToken when calling getTransactionForTransientToken'); } - // parse inputs $resourcePath = "/up/v1/payment-details/{transientToken}"; $httpBody = ''; diff --git a/lib/Api/UnifiedCheckoutCaptureContextApi.php b/lib/Api/UnifiedCheckoutCaptureContextApi.php index dd0243256..0299362eb 100644 --- a/lib/Api/UnifiedCheckoutCaptureContextApi.php +++ b/lib/Api/UnifiedCheckoutCaptureContextApi.php @@ -127,7 +127,6 @@ public function generateUnifiedCheckoutCaptureContextWithHttpInfo($generateUnifi self::$logger->error("InvalidArgumentException : Missing the required parameter $generateUnifiedCheckoutCaptureContextRequest when calling generateUnifiedCheckoutCaptureContext"); throw new \InvalidArgumentException('Missing the required parameter $generateUnifiedCheckoutCaptureContextRequest when calling generateUnifiedCheckoutCaptureContext'); } - // parse inputs $resourcePath = "/up/v1/capture-contexts"; $httpBody = ''; diff --git a/lib/Api/UserManagementApi.php b/lib/Api/UserManagementApi.php index b10d1ecf5..d830010e0 100644 --- a/lib/Api/UserManagementApi.php +++ b/lib/Api/UserManagementApi.php @@ -128,10 +128,6 @@ public function getUsers($organizationId = null, $userName = null, $permissionId */ public function getUsersWithHttpInfo($organizationId = null, $userName = null, $permissionId = null, $roleId = null) { - - - - // parse inputs $resourcePath = "/ums/v1/users"; $httpBody = ''; diff --git a/lib/Api/UserManagementSearchApi.php b/lib/Api/UserManagementSearchApi.php index b7e1f2c49..d2c76427a 100644 --- a/lib/Api/UserManagementSearchApi.php +++ b/lib/Api/UserManagementSearchApi.php @@ -127,7 +127,6 @@ public function searchUsersWithHttpInfo($searchRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $searchRequest when calling searchUsers"); throw new \InvalidArgumentException('Missing the required parameter $searchRequest when calling searchUsers'); } - // parse inputs $resourcePath = "/ums/v1/users/search"; $httpBody = ''; diff --git a/lib/Api/VerificationApi.php b/lib/Api/VerificationApi.php index 25c89040d..4f91d3337 100644 --- a/lib/Api/VerificationApi.php +++ b/lib/Api/VerificationApi.php @@ -127,7 +127,6 @@ public function validateExportComplianceWithHttpInfo($validateExportComplianceRe self::$logger->error("InvalidArgumentException : Missing the required parameter $validateExportComplianceRequest when calling validateExportCompliance"); throw new \InvalidArgumentException('Missing the required parameter $validateExportComplianceRequest when calling validateExportCompliance'); } - // parse inputs $resourcePath = "/risk/v1/export-compliance-inquiries"; $httpBody = ''; @@ -241,7 +240,6 @@ public function verifyCustomerAddressWithHttpInfo($verifyCustomerAddressRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $verifyCustomerAddressRequest when calling verifyCustomerAddress"); throw new \InvalidArgumentException('Missing the required parameter $verifyCustomerAddressRequest when calling verifyCustomerAddress'); } - // parse inputs $resourcePath = "/risk/v1/address-verifications"; $httpBody = ''; diff --git a/lib/Api/VoidApi.php b/lib/Api/VoidApi.php index 4909b25b2..c92f5183c 100644 --- a/lib/Api/VoidApi.php +++ b/lib/Api/VoidApi.php @@ -127,7 +127,6 @@ public function mitVoidWithHttpInfo($mitVoidRequest) self::$logger->error("InvalidArgumentException : Missing the required parameter $mitVoidRequest when calling mitVoid"); throw new \InvalidArgumentException('Missing the required parameter $mitVoidRequest when calling mitVoid'); } - // parse inputs $resourcePath = "/pts/v2/voids"; $httpBody = ''; @@ -243,13 +242,11 @@ public function voidCaptureWithHttpInfo($voidCaptureRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidCaptureRequest when calling voidCapture"); throw new \InvalidArgumentException('Missing the required parameter $voidCaptureRequest when calling voidCapture'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidCapture"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidCapture'); } - // parse inputs $resourcePath = "/pts/v2/captures/{id}/voids"; $httpBody = ''; @@ -373,13 +370,11 @@ public function voidCreditWithHttpInfo($voidCreditRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidCreditRequest when calling voidCredit"); throw new \InvalidArgumentException('Missing the required parameter $voidCreditRequest when calling voidCredit'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidCredit"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidCredit'); } - // parse inputs $resourcePath = "/pts/v2/credits/{id}/voids"; $httpBody = ''; @@ -503,13 +498,11 @@ public function voidPaymentWithHttpInfo($voidPaymentRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidPaymentRequest when calling voidPayment"); throw new \InvalidArgumentException('Missing the required parameter $voidPaymentRequest when calling voidPayment'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidPayment"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidPayment'); } - // parse inputs $resourcePath = "/pts/v2/payments/{id}/voids"; $httpBody = ''; @@ -633,13 +626,11 @@ public function voidRefundWithHttpInfo($voidRefundRequest, $id) self::$logger->error("InvalidArgumentException : Missing the required parameter $voidRefundRequest when calling voidRefund"); throw new \InvalidArgumentException('Missing the required parameter $voidRefundRequest when calling voidRefund'); } - // verify the required parameter 'id' is set if ($id === null) { self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling voidRefund"); throw new \InvalidArgumentException('Missing the required parameter $id when calling voidRefund'); } - // parse inputs $resourcePath = "/pts/v2/refunds/{id}/voids"; $httpBody = ''; From 812882d3b8fa6e02d4478985ecf23428ee733060 Mon Sep 17 00:00:00 2001 From: gaubansa Date: Thu, 20 Jun 2024 14:04:51 +0530 Subject: [PATCH 13/17] removing pattern check from valid func --- .../model_generic.mustache | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/generator/cybersource-php-template/model_generic.mustache b/generator/cybersource-php-template/model_generic.mustache index 400461d21..5d6b980e7 100644 --- a/generator/cybersource-php-template/model_generic.mustache +++ b/generator/cybersource-php-template/model_generic.mustache @@ -156,14 +156,6 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple {{/isContainer}} {{/isEnum}} - {{#hasValidation}} - {{#pattern}} - if ({{^required}}!is_null($this->container['{{name}}']) && {{/required}}!preg_match("{{{pattern}}}", $this->container['{{name}}'])) { - $invalid_properties[] = "invalid value for '{{name}}', must be conform to the pattern {{{pattern}}}."; - } - - {{/pattern}} - {{/hasValidation}} {{/vars}} return $invalid_properties; } @@ -196,13 +188,6 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple } {{/isContainer}} {{/isEnum}} - {{#hasValidation}} - {{#pattern}} - if (!preg_match("{{{pattern}}}", $this->container['{{name}}'])) { - return false; - } - {{/pattern}} - {{/hasValidation}} {{/vars}} return true; } From 90e6204638c6a95d2781d34a9d20e5412107d15f Mon Sep 17 00:00:00 2001 From: gaubansa Date: Thu, 20 Jun 2024 14:09:42 +0530 Subject: [PATCH 14/17] removing pattern check in valid function --- ...grationInformationTenantConfigurations.php | 7 --- ...v1registrationsOrganizationInformation.php | 14 ----- ...nizationInformationBusinessInformation.php | 49 --------------- ...nInformationBusinessInformationAddress.php | 42 ------------- ...tionBusinessInformationBusinessContact.php | 35 ----------- ...zationInformationKYCDepositBankAccount.php | 21 ------- ...strationsOrganizationInformationOwners.php | 63 ------------------- .../CardProcessingConfigCommonProcessors.php | 7 --- lib/Model/CreateAdhocReportRequest.php | 28 --------- lib/Model/CreateReportSubscriptionRequest.php | 35 ----------- ...grationInformationTenantConfigurations.php | 14 ----- ...grationInformationTenantConfigurations.php | 14 ----- ...neResponse2011ProductInformationSetups.php | 7 --- ...eInvoiceSettingsInformationHeaderStyle.php | 14 ----- ...onfigCardTypesVerifiedByVisaCurrencies.php | 14 ----- .../PredefinedSubscriptionRequestBean.php | 21 ------- ...atchesGet200ResponseTransactionBatches.php | 7 --- ...tsV1TransactionBatchesIdGet200Response.php | 7 --- ...bscriptionsGet200ResponseSubscriptions.php | 7 --- ...tEmvTags200ResponseEmvTagBreakdownList.php | 7 --- ...tEmvTags200ResponseEmvTagBreakdownList.php | 14 ----- 21 files changed, 427 deletions(-) diff --git a/lib/Model/Boardingv1registrationsIntegrationInformationTenantConfigurations.php b/lib/Model/Boardingv1registrationsIntegrationInformationTenantConfigurations.php index 07bc32c0f..42abfa941 100644 --- a/lib/Model/Boardingv1registrationsIntegrationInformationTenantConfigurations.php +++ b/lib/Model/Boardingv1registrationsIntegrationInformationTenantConfigurations.php @@ -152,10 +152,6 @@ public function listInvalidProperties() if ($this->container['solutionId'] === null) { $invalid_properties[] = "'solutionId' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z_]+$/", $this->container['solutionId'])) { - $invalid_properties[] = "invalid value for 'solutionId', must be conform to the pattern /^[0-9a-zA-Z_]+$/."; - } - return $invalid_properties; } @@ -171,9 +167,6 @@ public function valid() if ($this->container['solutionId'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z_]+$/", $this->container['solutionId'])) { - return false; - } return true; } diff --git a/lib/Model/Boardingv1registrationsOrganizationInformation.php b/lib/Model/Boardingv1registrationsOrganizationInformation.php index d1c14afb7..e5992e750 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformation.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformation.php @@ -223,14 +223,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['organizationId']) && !preg_match("/^[0-9a-zA-Z_]+$/", $this->container['organizationId'])) { - $invalid_properties[] = "invalid value for 'organizationId', must be conform to the pattern /^[0-9a-zA-Z_]+$/."; - } - - if (!is_null($this->container['parentOrganizationId']) && !preg_match("/^[0-9a-zA-Z_]+$/", $this->container['parentOrganizationId'])) { - $invalid_properties[] = "invalid value for 'parentOrganizationId', must be conform to the pattern /^[0-9a-zA-Z_]+$/."; - } - $allowed_values = $this->getTypeAllowableValues(); if (!in_array($this->container['type'], $allowed_values)) { $invalid_properties[] = sprintf( @@ -262,12 +254,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[0-9a-zA-Z_]+$/", $this->container['organizationId'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z_]+$/", $this->container['parentOrganizationId'])) { - return false; - } $allowed_values = $this->getTypeAllowableValues(); if (!in_array($this->container['type'], $allowed_values)) { return false; diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php index 5f65f3ec0..e5e2d744e 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformation.php @@ -436,18 +436,6 @@ public function listInvalidProperties() if ($this->container['name'] === null) { $invalid_properties[] = "'name' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - $invalid_properties[] = "invalid value for 'name', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } - - if (!is_null($this->container['doingBusinessAs']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - $invalid_properties[] = "invalid value for 'doingBusinessAs', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } - - if (!is_null($this->container['description']) && !preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { - $invalid_properties[] = "invalid value for 'description', must be conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."; - } - $allowed_values = $this->getTimeZoneAllowableValues(); if (!in_array($this->container['timeZone'], $allowed_values)) { $invalid_properties[] = sprintf( @@ -456,10 +444,6 @@ public function listInvalidProperties() ); } - if (!is_null($this->container['websiteUrl']) && !preg_match("/\\b((?:https?:\/\/|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}\/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»“”‘’]))/", $this->container['websiteUrl'])) { - $invalid_properties[] = "invalid value for 'websiteUrl', must be conform to the pattern /\\b((?:https?:\/\/|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}\/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»“”‘’]))/."; - } - $allowed_values = $this->getTypeAllowableValues(); if (!in_array($this->container['type'], $allowed_values)) { $invalid_properties[] = sprintf( @@ -468,18 +452,6 @@ public function listInvalidProperties() ); } - if (!is_null($this->container['taxId']) && !preg_match("/\\d{9}/", $this->container['taxId'])) { - $invalid_properties[] = "invalid value for 'taxId', must be conform to the pattern /\\d{9}/."; - } - - if (!is_null($this->container['phoneNumber']) && !preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $this->container['phoneNumber'])) { - $invalid_properties[] = "invalid value for 'phoneNumber', must be conform to the pattern /^[0-9a-zA-Z\\\\+\\\\-]+$/."; - } - - if (!is_null($this->container['merchantCategoryCode']) && !preg_match("/^\\d{3,4}$/", $this->container['merchantCategoryCode'])) { - $invalid_properties[] = "invalid value for 'merchantCategoryCode', must be conform to the pattern /^\\d{3,4}$/."; - } - return $invalid_properties; } @@ -495,35 +467,14 @@ public function valid() if ($this->container['name'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['name'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['doingBusinessAs'])) { - return false; - } - if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿ\\n\\ra-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['description'])) { - return false; - } $allowed_values = $this->getTimeZoneAllowableValues(); if (!in_array($this->container['timeZone'], $allowed_values)) { return false; } - if (!preg_match("/\\b((?:https?:\/\/|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}\/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»“”‘’]))/", $this->container['websiteUrl'])) { - return false; - } $allowed_values = $this->getTypeAllowableValues(); if (!in_array($this->container['type'], $allowed_values)) { return false; } - if (!preg_match("/\\d{9}/", $this->container['taxId'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $this->container['phoneNumber'])) { - return false; - } - if (!preg_match("/^\\d{3,4}$/", $this->container['merchantCategoryCode'])) { - return false; - } return true; } diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php index 4ce93b02e..878c3e75c 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationAddress.php @@ -176,36 +176,12 @@ public function listInvalidProperties() if ($this->container['country'] === null) { $invalid_properties[] = "'country' can't be null"; } - if (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['country'])) { - $invalid_properties[] = "invalid value for 'country', must be conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."; - } - if ($this->container['address1'] === null) { $invalid_properties[] = "'address1' can't be null"; } - if (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['address1'])) { - $invalid_properties[] = "invalid value for 'address1', must be conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."; - } - - if (!is_null($this->container['address2']) && !preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['address2'])) { - $invalid_properties[] = "invalid value for 'address2', must be conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."; - } - if ($this->container['locality'] === null) { $invalid_properties[] = "'locality' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - $invalid_properties[] = "invalid value for 'locality', must be conform to the pattern /^[0-9a-zA-Z _\\-¡-￿]+$/."; - } - - if (!is_null($this->container['administrativeArea']) && !preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - $invalid_properties[] = "invalid value for 'administrativeArea', must be conform to the pattern /^[0-9a-zA-Z¡-￿ ]*$/."; - } - - if (!is_null($this->container['postalCode']) && !preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { - $invalid_properties[] = "invalid value for 'postalCode', must be conform to the pattern /^[0-9a-zA-Z ]*$/."; - } - return $invalid_properties; } @@ -221,30 +197,12 @@ public function valid() if ($this->container['country'] === null) { return false; } - if (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['country'])) { - return false; - } if ($this->container['address1'] === null) { return false; } - if (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['address1'])) { - return false; - } - if (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['address2'])) { - return false; - } if ($this->container['locality'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z _\\-¡-￿]+$/", $this->container['locality'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z¡-￿ ]*$/", $this->container['administrativeArea'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z ]*$/", $this->container['postalCode'])) { - return false; - } return true; } diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php index d9c259897..419d5c5c5 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationBusinessInformationBusinessContact.php @@ -170,35 +170,15 @@ public function listInvalidProperties() if ($this->container['firstName'] === null) { $invalid_properties[] = "'firstName' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } - - if (!is_null($this->container['middleName']) && !preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } - if ($this->container['lastName'] === null) { $invalid_properties[] = "'lastName' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/."; - } - if ($this->container['phoneNumber'] === null) { $invalid_properties[] = "'phoneNumber' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $this->container['phoneNumber'])) { - $invalid_properties[] = "invalid value for 'phoneNumber', must be conform to the pattern /^[0-9a-zA-Z\\\\+\\\\-]+$/."; - } - if ($this->container['email'] === null) { $invalid_properties[] = "'email' can't be null"; } - if (!preg_match("/^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/", $this->container['email'])) { - $invalid_properties[] = "invalid value for 'email', must be conform to the pattern /^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/."; - } - return $invalid_properties; } @@ -214,30 +194,15 @@ public function valid() if ($this->container['firstName'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['firstName'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['middleName'])) { - return false; - } if ($this->container['lastName'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z _\\-\\+\\.\\*\\\"\/'&\\,\\(\\)!$;:?@\\#¡-￿]+$/", $this->container['lastName'])) { - return false; - } if ($this->container['phoneNumber'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $this->container['phoneNumber'])) { - return false; - } if ($this->container['email'] === null) { return false; } - if (!preg_match("/^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/", $this->container['email'])) { - return false; - } return true; } diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.php b/lib/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.php index 8a07e7243..d27668024 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.php @@ -182,10 +182,6 @@ public function listInvalidProperties() if ($this->container['accountHolderName'] === null) { $invalid_properties[] = "'accountHolderName' can't be null"; } - if (!preg_match("/^[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['accountHolderName'])) { - $invalid_properties[] = "invalid value for 'accountHolderName', must be conform to the pattern /^[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."; - } - if ($this->container['accountType'] === null) { $invalid_properties[] = "'accountType' can't be null"; } @@ -200,17 +196,9 @@ public function listInvalidProperties() if ($this->container['accountRoutingNumber'] === null) { $invalid_properties[] = "'accountRoutingNumber' can't be null"; } - if (!preg_match("/\\d{9}/", $this->container['accountRoutingNumber'])) { - $invalid_properties[] = "invalid value for 'accountRoutingNumber', must be conform to the pattern /\\d{9}/."; - } - if ($this->container['accountNumber'] === null) { $invalid_properties[] = "'accountNumber' can't be null"; } - if (!preg_match("/^\\d{5,17}$/", $this->container['accountNumber'])) { - $invalid_properties[] = "invalid value for 'accountNumber', must be conform to the pattern /^\\d{5,17}$/."; - } - return $invalid_properties; } @@ -226,9 +214,6 @@ public function valid() if ($this->container['accountHolderName'] === null) { return false; } - if (!preg_match("/^[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['accountHolderName'])) { - return false; - } if ($this->container['accountType'] === null) { return false; } @@ -239,15 +224,9 @@ public function valid() if ($this->container['accountRoutingNumber'] === null) { return false; } - if (!preg_match("/\\d{9}/", $this->container['accountRoutingNumber'])) { - return false; - } if ($this->container['accountNumber'] === null) { return false; } - if (!preg_match("/^\\d{5,17}$/", $this->container['accountNumber'])) { - return false; - } return true; } diff --git a/lib/Model/Boardingv1registrationsOrganizationInformationOwners.php b/lib/Model/Boardingv1registrationsOrganizationInformationOwners.php index aef204523..dccfbbd70 100644 --- a/lib/Model/Boardingv1registrationsOrganizationInformationOwners.php +++ b/lib/Model/Boardingv1registrationsOrganizationInformationOwners.php @@ -224,46 +224,18 @@ public function listInvalidProperties() if ($this->container['firstName'] === null) { $invalid_properties[] = "'firstName' can't be null"; } - if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['firstName'])) { - $invalid_properties[] = "invalid value for 'firstName', must be conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."; - } - - if (!is_null($this->container['middleName']) && !preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['middleName'])) { - $invalid_properties[] = "invalid value for 'middleName', must be conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."; - } - if ($this->container['lastName'] === null) { $invalid_properties[] = "'lastName' can't be null"; } - if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['lastName'])) { - $invalid_properties[] = "invalid value for 'lastName', must be conform to the pattern /[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/."; - } - if ($this->container['birthDate'] === null) { $invalid_properties[] = "'birthDate' can't be null"; } if ($this->container['isPrimary'] === null) { $invalid_properties[] = "'isPrimary' can't be null"; } - if (!is_null($this->container['ssn']) && !preg_match("/^\\d{3}-\\d{2}-\\d{4}$|^\\d{9,9}$/", $this->container['ssn'])) { - $invalid_properties[] = "invalid value for 'ssn', must be conform to the pattern /^\\d{3}-\\d{2}-\\d{4}$|^\\d{9,9}$/."; - } - - if (!is_null($this->container['passportNumber']) && !preg_match("/^(?!^0+$)[a-zA-Z0-9]{3,20}$/", $this->container['passportNumber'])) { - $invalid_properties[] = "invalid value for 'passportNumber', must be conform to the pattern /^(?!^0+$)[a-zA-Z0-9]{3,20}$/."; - } - - if (!is_null($this->container['passportCountry']) && !preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['passportCountry'])) { - $invalid_properties[] = "invalid value for 'passportCountry', must be conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."; - } - if ($this->container['jobTitle'] === null) { $invalid_properties[] = "'jobTitle' can't be null"; } - if (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['jobTitle'])) { - $invalid_properties[] = "invalid value for 'jobTitle', must be conform to the pattern /^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/."; - } - if ($this->container['hasSignificantResponsability'] === null) { $invalid_properties[] = "'hasSignificantResponsability' can't be null"; } @@ -273,17 +245,9 @@ public function listInvalidProperties() if ($this->container['phoneNumber'] === null) { $invalid_properties[] = "'phoneNumber' can't be null"; } - if (!preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $this->container['phoneNumber'])) { - $invalid_properties[] = "invalid value for 'phoneNumber', must be conform to the pattern /^[0-9a-zA-Z\\\\+\\\\-]+$/."; - } - if ($this->container['email'] === null) { $invalid_properties[] = "'email' can't be null"; } - if (!preg_match("/^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/", $this->container['email'])) { - $invalid_properties[] = "invalid value for 'email', must be conform to the pattern /^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/."; - } - if ($this->container['address'] === null) { $invalid_properties[] = "'address' can't be null"; } @@ -302,39 +266,18 @@ public function valid() if ($this->container['firstName'] === null) { return false; } - if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['firstName'])) { - return false; - } - if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['middleName'])) { - return false; - } if ($this->container['lastName'] === null) { return false; } - if (!preg_match("/[À-ÖØ-öø-ǿÀ-ÖØ-öø-ǿa-zA-Z().\\-_#,;\/\\\\@$:&!?%«»€₣«»€₣ ]{1,}$/", $this->container['lastName'])) { - return false; - } if ($this->container['birthDate'] === null) { return false; } if ($this->container['isPrimary'] === null) { return false; } - if (!preg_match("/^\\d{3}-\\d{2}-\\d{4}$|^\\d{9,9}$/", $this->container['ssn'])) { - return false; - } - if (!preg_match("/^(?!^0+$)[a-zA-Z0-9]{3,20}$/", $this->container['passportNumber'])) { - return false; - } - if (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['passportCountry'])) { - return false; - } if ($this->container['jobTitle'] === null) { return false; } - if (!preg_match("/^[À-ÖØ-öø-ǿa-zA-Z0-9().\\-_#,;\/@$:!% ]{1,}$/", $this->container['jobTitle'])) { - return false; - } if ($this->container['hasSignificantResponsability'] === null) { return false; } @@ -344,15 +287,9 @@ public function valid() if ($this->container['phoneNumber'] === null) { return false; } - if (!preg_match("/^[0-9a-zA-Z\\\\+\\\\-]+$/", $this->container['phoneNumber'])) { - return false; - } if ($this->container['email'] === null) { return false; } - if (!preg_match("/^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$/", $this->container['email'])) { - return false; - } if ($this->container['address'] === null) { return false; } diff --git a/lib/Model/CardProcessingConfigCommonProcessors.php b/lib/Model/CardProcessingConfigCommonProcessors.php index 5cadd9a5f..903ba9ab6 100644 --- a/lib/Model/CardProcessingConfigCommonProcessors.php +++ b/lib/Model/CardProcessingConfigCommonProcessors.php @@ -444,10 +444,6 @@ public function listInvalidProperties() ); } - if (!is_null($this->container['merchantTier']) && !preg_match("/^[0-9]+$/", $this->container['merchantTier'])) { - $invalid_properties[] = "invalid value for 'merchantTier', must be conform to the pattern /^[0-9]+$/."; - } - return $invalid_properties; } @@ -467,9 +463,6 @@ public function valid() if (!in_array($this->container['industryCode'], $allowed_values)) { return false; } - if (!preg_match("/^[0-9]+$/", $this->container['merchantTier'])) { - return false; - } return true; } diff --git a/lib/Model/CreateAdhocReportRequest.php b/lib/Model/CreateAdhocReportRequest.php index 416d0c216..a241fb397 100644 --- a/lib/Model/CreateAdhocReportRequest.php +++ b/lib/Model/CreateAdhocReportRequest.php @@ -203,22 +203,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['organizationId']) && !preg_match("/[a-zA-Z0-9-_]+/", $this->container['organizationId'])) { - $invalid_properties[] = "invalid value for 'organizationId', must be conform to the pattern /[a-zA-Z0-9-_]+/."; - } - - if (!is_null($this->container['reportDefinitionName']) && !preg_match("/[a-zA-Z0-9-]+/", $this->container['reportDefinitionName'])) { - $invalid_properties[] = "invalid value for 'reportDefinitionName', must be conform to the pattern /[a-zA-Z0-9-]+/."; - } - - if (!is_null($this->container['reportName']) && !preg_match("/[a-zA-Z0-9-_ ]+/", $this->container['reportName'])) { - $invalid_properties[] = "invalid value for 'reportName', must be conform to the pattern /[a-zA-Z0-9-_ ]+/."; - } - - if (!is_null($this->container['groupName']) && !preg_match("/[0-9]*/", $this->container['groupName'])) { - $invalid_properties[] = "invalid value for 'groupName', must be conform to the pattern /[0-9]*/."; - } - return $invalid_properties; } @@ -231,18 +215,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/[a-zA-Z0-9-_]+/", $this->container['organizationId'])) { - return false; - } - if (!preg_match("/[a-zA-Z0-9-]+/", $this->container['reportDefinitionName'])) { - return false; - } - if (!preg_match("/[a-zA-Z0-9-_ ]+/", $this->container['reportName'])) { - return false; - } - if (!preg_match("/[0-9]*/", $this->container['groupName'])) { - return false; - } return true; } diff --git a/lib/Model/CreateReportSubscriptionRequest.php b/lib/Model/CreateReportSubscriptionRequest.php index 92147b87a..c0412eb9d 100644 --- a/lib/Model/CreateReportSubscriptionRequest.php +++ b/lib/Model/CreateReportSubscriptionRequest.php @@ -215,17 +215,9 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['organizationId']) && !preg_match("/[a-zA-Z0-9-_]+/", $this->container['organizationId'])) { - $invalid_properties[] = "invalid value for 'organizationId', must be conform to the pattern /[a-zA-Z0-9-_]+/."; - } - if ($this->container['reportDefinitionName'] === null) { $invalid_properties[] = "'reportDefinitionName' can't be null"; } - if (!preg_match("/[a-zA-Z0-9-]+/", $this->container['reportDefinitionName'])) { - $invalid_properties[] = "invalid value for 'reportDefinitionName', must be conform to the pattern /[a-zA-Z0-9-]+/."; - } - if ($this->container['reportFields'] === null) { $invalid_properties[] = "'reportFields' can't be null"; } @@ -235,27 +227,15 @@ public function listInvalidProperties() if ($this->container['reportFrequency'] === null) { $invalid_properties[] = "'reportFrequency' can't be null"; } - if (!is_null($this->container['reportInterval']) && !preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $this->container['reportInterval'])) { - $invalid_properties[] = "invalid value for 'reportInterval', must be conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/."; - } - if ($this->container['reportName'] === null) { $invalid_properties[] = "'reportName' can't be null"; } - if (!preg_match("/[a-zA-Z0-9-_ ]+/", $this->container['reportName'])) { - $invalid_properties[] = "invalid value for 'reportName', must be conform to the pattern /[a-zA-Z0-9-_ ]+/."; - } - if ($this->container['timezone'] === null) { $invalid_properties[] = "'timezone' can't be null"; } if ($this->container['startTime'] === null) { $invalid_properties[] = "'startTime' can't be null"; } - if (!is_null($this->container['groupName']) && !preg_match("/[a-zA-Z0-9-_ ]+/", $this->container['groupName'])) { - $invalid_properties[] = "invalid value for 'groupName', must be conform to the pattern /[a-zA-Z0-9-_ ]+/."; - } - return $invalid_properties; } @@ -268,15 +248,9 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/[a-zA-Z0-9-_]+/", $this->container['organizationId'])) { - return false; - } if ($this->container['reportDefinitionName'] === null) { return false; } - if (!preg_match("/[a-zA-Z0-9-]+/", $this->container['reportDefinitionName'])) { - return false; - } if ($this->container['reportFields'] === null) { return false; } @@ -286,24 +260,15 @@ public function valid() if ($this->container['reportFrequency'] === null) { return false; } - if (!preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $this->container['reportInterval'])) { - return false; - } if ($this->container['reportName'] === null) { return false; } - if (!preg_match("/[a-zA-Z0-9-_ ]+/", $this->container['reportName'])) { - return false; - } if ($this->container['timezone'] === null) { return false; } if ($this->container['startTime'] === null) { return false; } - if (!preg_match("/[a-zA-Z0-9-_ ]+/", $this->container['groupName'])) { - return false; - } return true; } diff --git a/lib/Model/InlineResponse2002IntegrationInformationTenantConfigurations.php b/lib/Model/InlineResponse2002IntegrationInformationTenantConfigurations.php index e3b7e0a31..b4f1b99c3 100644 --- a/lib/Model/InlineResponse2002IntegrationInformationTenantConfigurations.php +++ b/lib/Model/InlineResponse2002IntegrationInformationTenantConfigurations.php @@ -183,14 +183,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['solutionId']) && !preg_match("/^[0-9a-zA-Z_]+$/", $this->container['solutionId'])) { - $invalid_properties[] = "invalid value for 'solutionId', must be conform to the pattern /^[0-9a-zA-Z_]+$/."; - } - - if (!is_null($this->container['tenantConfigurationId']) && !preg_match("/^[0-9a-zA-Z_]+$/", $this->container['tenantConfigurationId'])) { - $invalid_properties[] = "invalid value for 'tenantConfigurationId', must be conform to the pattern /^[0-9a-zA-Z_]+$/."; - } - $allowed_values = $this->getStatusAllowableValues(); if (!in_array($this->container['status'], $allowed_values)) { $invalid_properties[] = sprintf( @@ -211,12 +203,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[0-9a-zA-Z_]+$/", $this->container['solutionId'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z_]+$/", $this->container['tenantConfigurationId'])) { - return false; - } $allowed_values = $this->getStatusAllowableValues(); if (!in_array($this->container['status'], $allowed_values)) { return false; diff --git a/lib/Model/InlineResponse2011IntegrationInformationTenantConfigurations.php b/lib/Model/InlineResponse2011IntegrationInformationTenantConfigurations.php index dc48e0b17..eae9b5768 100644 --- a/lib/Model/InlineResponse2011IntegrationInformationTenantConfigurations.php +++ b/lib/Model/InlineResponse2011IntegrationInformationTenantConfigurations.php @@ -177,14 +177,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['solutionId']) && !preg_match("/^[0-9a-zA-Z_]+$/", $this->container['solutionId'])) { - $invalid_properties[] = "invalid value for 'solutionId', must be conform to the pattern /^[0-9a-zA-Z_]+$/."; - } - - if (!is_null($this->container['tenantConfigurationId']) && !preg_match("/^[0-9a-zA-Z_]+$/", $this->container['tenantConfigurationId'])) { - $invalid_properties[] = "invalid value for 'tenantConfigurationId', must be conform to the pattern /^[0-9a-zA-Z_]+$/."; - } - $allowed_values = $this->getStatusAllowableValues(); if (!in_array($this->container['status'], $allowed_values)) { $invalid_properties[] = sprintf( @@ -205,12 +197,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[0-9a-zA-Z_]+$/", $this->container['solutionId'])) { - return false; - } - if (!preg_match("/^[0-9a-zA-Z_]+$/", $this->container['tenantConfigurationId'])) { - return false; - } $allowed_values = $this->getStatusAllowableValues(); if (!in_array($this->container['status'], $allowed_values)) { return false; diff --git a/lib/Model/InlineResponse2011ProductInformationSetups.php b/lib/Model/InlineResponse2011ProductInformationSetups.php index 174f44b2a..24b0c8fab 100644 --- a/lib/Model/InlineResponse2011ProductInformationSetups.php +++ b/lib/Model/InlineResponse2011ProductInformationSetups.php @@ -149,10 +149,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['organizationId']) && !preg_match("/^[0-9a-zA-Z]+$/", $this->container['organizationId'])) { - $invalid_properties[] = "invalid value for 'organizationId', must be conform to the pattern /^[0-9a-zA-Z]+$/."; - } - return $invalid_properties; } @@ -165,9 +161,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[0-9a-zA-Z]+$/", $this->container['organizationId'])) { - return false; - } return true; } diff --git a/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.php b/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.php index 826b5091f..df8c25472 100644 --- a/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.php +++ b/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.php @@ -149,14 +149,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['fontColor']) && !preg_match("/^#(?:[0-9a-fA-F]{3}){1,2}$/", $this->container['fontColor'])) { - $invalid_properties[] = "invalid value for 'fontColor', must be conform to the pattern /^#(?:[0-9a-fA-F]{3}){1,2}$/."; - } - - if (!is_null($this->container['backgroundColor']) && !preg_match("/^#(?:[0-9a-fA-F]{3}){1,2}$/", $this->container['backgroundColor'])) { - $invalid_properties[] = "invalid value for 'backgroundColor', must be conform to the pattern /^#(?:[0-9a-fA-F]{3}){1,2}$/."; - } - return $invalid_properties; } @@ -169,12 +161,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^#(?:[0-9a-fA-F]{3}){1,2}$/", $this->container['fontColor'])) { - return false; - } - if (!preg_match("/^#(?:[0-9a-fA-F]{3}){1,2}$/", $this->container['backgroundColor'])) { - return false; - } return true; } diff --git a/lib/Model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies.php b/lib/Model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies.php index 1725e17eb..37b31e251 100644 --- a/lib/Model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies.php +++ b/lib/Model/PayerAuthConfigCardTypesVerifiedByVisaCurrencies.php @@ -155,14 +155,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['acquirerId']) && !preg_match("/^[a-zA-Z0-9]{6,20}$/", $this->container['acquirerId'])) { - $invalid_properties[] = "invalid value for 'acquirerId', must be conform to the pattern /^[a-zA-Z0-9]{6,20}$/."; - } - - if (!is_null($this->container['processorMerchantId']) && !preg_match("/^[a-zA-Z0-9]{6,35}$/", $this->container['processorMerchantId'])) { - $invalid_properties[] = "invalid value for 'processorMerchantId', must be conform to the pattern /^[a-zA-Z0-9]{6,35}$/."; - } - return $invalid_properties; } @@ -175,12 +167,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[a-zA-Z0-9]{6,20}$/", $this->container['acquirerId'])) { - return false; - } - if (!preg_match("/^[a-zA-Z0-9]{6,35}$/", $this->container['processorMerchantId'])) { - return false; - } return true; } diff --git a/lib/Model/PredefinedSubscriptionRequestBean.php b/lib/Model/PredefinedSubscriptionRequestBean.php index 40f4ff1d4..390410d01 100644 --- a/lib/Model/PredefinedSubscriptionRequestBean.php +++ b/lib/Model/PredefinedSubscriptionRequestBean.php @@ -200,21 +200,9 @@ public function listInvalidProperties() if ($this->container['reportDefinitionName'] === null) { $invalid_properties[] = "'reportDefinitionName' can't be null"; } - if (!preg_match("/[a-zA-Z]+/", $this->container['reportDefinitionName'])) { - $invalid_properties[] = "invalid value for 'reportDefinitionName', must be conform to the pattern /[a-zA-Z]+/."; - } - if ($this->container['subscriptionType'] === null) { $invalid_properties[] = "'subscriptionType' can't be null"; } - if (!is_null($this->container['reportName']) && !preg_match("/[a-zA-Z0-9-_ ]+/", $this->container['reportName'])) { - $invalid_properties[] = "invalid value for 'reportName', must be conform to the pattern /[a-zA-Z0-9-_ ]+/."; - } - - if (!is_null($this->container['reportInterval']) && !preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $this->container['reportInterval'])) { - $invalid_properties[] = "invalid value for 'reportInterval', must be conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/."; - } - return $invalid_properties; } @@ -230,18 +218,9 @@ public function valid() if ($this->container['reportDefinitionName'] === null) { return false; } - if (!preg_match("/[a-zA-Z]+/", $this->container['reportDefinitionName'])) { - return false; - } if ($this->container['subscriptionType'] === null) { return false; } - if (!preg_match("/[a-zA-Z0-9-_ ]+/", $this->container['reportName'])) { - return false; - } - if (!preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $this->container['reportInterval'])) { - return false; - } return true; } diff --git a/lib/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.php b/lib/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.php index 9c8b22842..0b774b9fc 100644 --- a/lib/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.php +++ b/lib/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.php @@ -179,10 +179,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['id']) && !preg_match("/^[a-zA-Z0-9_+-]*$/", $this->container['id'])) { - $invalid_properties[] = "invalid value for 'id', must be conform to the pattern /^[a-zA-Z0-9_+-]*$/."; - } - return $invalid_properties; } @@ -195,9 +191,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[a-zA-Z0-9_+-]*$/", $this->container['id'])) { - return false; - } return true; } diff --git a/lib/Model/PtsV1TransactionBatchesIdGet200Response.php b/lib/Model/PtsV1TransactionBatchesIdGet200Response.php index 9e54adf50..dd19d49b6 100644 --- a/lib/Model/PtsV1TransactionBatchesIdGet200Response.php +++ b/lib/Model/PtsV1TransactionBatchesIdGet200Response.php @@ -185,10 +185,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['id']) && !preg_match("/^[a-zA-Z0-9_+-]*$/", $this->container['id'])) { - $invalid_properties[] = "invalid value for 'id', must be conform to the pattern /^[a-zA-Z0-9_+-]*$/."; - } - return $invalid_properties; } @@ -201,9 +197,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[a-zA-Z0-9_+-]*$/", $this->container['id'])) { - return false; - } return true; } diff --git a/lib/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.php b/lib/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.php index 7b26bd619..5d975c735 100644 --- a/lib/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.php +++ b/lib/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.php @@ -222,10 +222,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['reportInterval']) && !preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $this->container['reportInterval'])) { - $invalid_properties[] = "invalid value for 'reportInterval', must be conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/."; - } - return $invalid_properties; } @@ -238,9 +234,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/", $this->container['reportInterval'])) { - return false; - } return true; } diff --git a/lib/Model/TssV2GetEmvTags200ResponseEmvTagBreakdownList.php b/lib/Model/TssV2GetEmvTags200ResponseEmvTagBreakdownList.php index 7c83bca7f..f84a5a7b4 100644 --- a/lib/Model/TssV2GetEmvTags200ResponseEmvTagBreakdownList.php +++ b/lib/Model/TssV2GetEmvTags200ResponseEmvTagBreakdownList.php @@ -149,10 +149,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['tag']) && !preg_match("/^[0-9A-F]*$/", $this->container['tag'])) { - $invalid_properties[] = "invalid value for 'tag', must be conform to the pattern /^[0-9A-F]*$/."; - } - return $invalid_properties; } @@ -165,9 +161,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[0-9A-F]*$/", $this->container['tag'])) { - return false; - } return true; } diff --git a/lib/Model/TssV2PostEmvTags200ResponseEmvTagBreakdownList.php b/lib/Model/TssV2PostEmvTags200ResponseEmvTagBreakdownList.php index 6a465cd27..3456d107e 100644 --- a/lib/Model/TssV2PostEmvTags200ResponseEmvTagBreakdownList.php +++ b/lib/Model/TssV2PostEmvTags200ResponseEmvTagBreakdownList.php @@ -167,14 +167,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if (!is_null($this->container['tag']) && !preg_match("/^[0-9A-F]*$/", $this->container['tag'])) { - $invalid_properties[] = "invalid value for 'tag', must be conform to the pattern /^[0-9A-F]*$/."; - } - - if (!is_null($this->container['value']) && !preg_match("/^[0-9A-F|X]*$/", $this->container['value'])) { - $invalid_properties[] = "invalid value for 'value', must be conform to the pattern /^[0-9A-F|X]*$/."; - } - return $invalid_properties; } @@ -187,12 +179,6 @@ public function listInvalidProperties() public function valid() { - if (!preg_match("/^[0-9A-F]*$/", $this->container['tag'])) { - return false; - } - if (!preg_match("/^[0-9A-F|X]*$/", $this->container['value'])) { - return false; - } return true; } From 463a1a35f71f8ac16b9f66970c840feb804ba98e Mon Sep 17 00:00:00 2001 From: monkumar Date: Thu, 20 Jun 2024 14:57:40 +0530 Subject: [PATCH 15/17] api spec changes --- docs/Api/TransactionBatchesApi.md | 4 +- ...nsResponseOrderInformationAmountDetails.md | 2 +- ...et200ResponseInvoiceSettingsInformation.md | 2 +- ...cesAllGet200ResponseCustomerInformation.md | 2 +- ...00ResponseOrderInformationAmountDetails.md | 4 +- ...nvoicesGet200ResponseTransactionDetails.md | 2 +- ...01ResponseOrderInformationAmountDetails.md | 4 +- ...voiceSettingsInvoiceSettingsInformation.md | 2 +- .../Invoicingv2invoicesCustomerInformation.md | 4 +- ...ingv2invoicesCustomerInformationCompany.md | 2 +- ...v2invoicesOrderInformationAmountDetails.md | 4 +- ...cesOrderInformationAmountDetailsFreight.md | 2 +- .../Kmsv2keyssymClientReferenceInformation.md | 2 +- .../Model/PatchInstrumentIdentifierRequest.md | 4 +- ...stInstrumentIdentifierEnrollmentRequest.md | 4 +- docs/Model/PostInstrumentIdentifierRequest.md | 4 +- ...editsPost201ResponseCreditAmountDetails.md | 2 +- ...rocessingInformationBankTransferOptions.md | 2 +- ...01ResponseOrderInformationAmountDetails.md | 2 +- ...eBuyerInformationPersonalIdentification.md | 4 +- ...01ResponseOrderInformationAmountDetails.md | 2 +- ...sPost201Response1OrderInformationBillTo.md | 2 +- ...1Response2OrderInformationAmountDetails.md | 2 +- ...PaymentsPost201ResponseBuyerInformation.md | 6 +- ...sponseConsumerAuthenticationInformation.md | 6 +- ...01ResponseOrderInformationAmountDetails.md | 4 +- ...ymentsPost201ResponsePaymentInformation.md | 10 +- ...tsPost201ResponsePaymentInformationBank.md | 2 +- ...01ResponsePaymentInformationBankAccount.md | 2 +- ...rocessingInformationBankTransferOptions.md | 4 +- ...onseProcessorInformationAchVerification.md | 4 +- ...nseProcessorInformationCardVerification.md | 2 +- ...nformationElectronicVerificationResults.md | 10 +- ...01ResponseOrderInformationAmountDetails.md | 4 +- ...efundPost201ResponseRefundAmountDetails.md | 2 +- ...alsPost201ResponseReversalAmountDetails.md | 2 +- ...tsVoidsPost201ResponseVoidAmountDetails.md | 2 +- ...01ResponseOrderInformationAmountDetails.md | 4 +- ...1pushfundstransferAggregatorInformation.md | 12 - ...ransferAggregatorInformationSubMerchant.md | 18 - ...fundstransferMerchantDefinedInformation.md | 11 - ...sv1pushfundstransferMerchantInformation.md | 13 - ...erMerchantInformationMerchantDescriptor.md | 16 - .../Ptsv1pushfundstransferOrderInformation.md | 2 - ...dstransferOrderInformationAmountDetails.md | 6 +- ...hfundstransferOrderInformationSurcharge.md | 10 - ...hfundstransferPointOfServiceInformation.md | 14 - ...1pushfundstransferProcessingInformation.md | 8 +- ...sferProcessingInformationPayoutsOptions.md | 4 +- ...erProcessingInformationRecurringOptions.md | 10 - ...Ptsv1pushfundstransferProcessingOptions.md | 10 - ...transferProcessingOptionsFundingOptions.md | 10 - ...rocessingOptionsFundingOptionsInitiator.md | 10 - ...v1pushfundstransferRecipientInformation.md | 18 +- ...ipientInformationPaymentInformationCard.md | 2 +- ...ipientInformationPersonalIdentification.md | 5 +- ...Ptsv1pushfundstransferSenderInformation.md | 17 +- ...shfundstransferSenderInformationAccount.md | 2 +- ...SenderInformationPaymentInformationCard.md | 10 +- ...SenderInformationPersonalIdentification.md | 5 +- ...2billingagreementsAggregatorInformation.md | 2 +- .../Ptsv2billingagreementsBuyerInformation.md | 2 +- ...ingagreementsClientReferenceInformation.md | 2 +- ...billingagreementsOrderInformationBillTo.md | 2 +- ...tsv2billingagreementsidBuyerInformation.md | 2 +- .../Ptsv2creditsProcessingInformation.md | 6 +- ...rocessingInformationBankTransferOptions.md | 6 +- .../Ptsv2paymentreferencesBuyerInformation.md | 2 +- ...referencesOrderInformationAmountDetails.md | 6 +- ...paymentreferencesPaymentInformationBank.md | 2 +- ...referencesPaymentInformationBankAccount.md | 2 +- .../Ptsv2paymentsAggregatorInformation.md | 4 +- docs/Model/Ptsv2paymentsBuyerInformation.md | 8 +- ...sBuyerInformationPersonalIdentification.md | 6 +- ...Ptsv2paymentsClientReferenceInformation.md | 2 +- ...ymentsConsumerAuthenticationInformation.md | 14 +- ...Ptsv2paymentsMerchantDefinedInformation.md | 4 +- ...v2paymentsOrderInformationAmountDetails.md | 10 +- ...ationAmountDetailsAmexAdditionalAmounts.md | 2 +- .../Ptsv2paymentsOrderInformationBillTo.md | 2 +- ...v2paymentsOrderInformationBillToCompany.md | 2 +- .../Ptsv2paymentsPaymentInformationBank.md | 6 +- ...v2paymentsPaymentInformationBankAccount.md | 4 +- ...Ptsv2paymentsPaymentInformationCustomer.md | 2 +- .../Ptsv2paymentsProcessingInformation.md | 10 +- ...ocessingInformationAuthorizationOptions.md | 4 +- ...nformationAuthorizationOptionsInitiator.md | 2 +- ...nsInitiatorMerchantInitiatedTransaction.md | 4 +- ...rocessingInformationBankTransferOptions.md | 10 +- docs/Model/Ptsv2paymentsTokenInformation.md | 1 + ...nformationTokenProvisioningInformation.md} | 2 +- ...paymentsidOrderInformationAmountDetails.md | 2 +- ...paymentsidcapturesAggregatorInformation.md | 4 +- ...Ptsv2paymentsidcapturesBuyerInformation.md | 6 +- ...sBuyerInformationPersonalIdentification.md | 2 +- ...idcapturesOrderInformationAmountDetails.md | 10 +- ...aymentsidcapturesOrderInformationBillTo.md | 2 +- ...paymentsidcapturesProcessingInformation.md | 4 +- ...ocessingInformationAuthorizationOptions.md | 4 +- ...entsidrefundsClientReferenceInformation.md | 2 +- ...paymentsidrefundsPaymentInformationBank.md | 6 +- ...sidrefundsPaymentInformationBankAccount.md | 2 +- ...2paymentsidrefundsProcessingInformation.md | 4 +- ...tsidreversalsClientReferenceInformation.md | 2 +- ...aymentsidreversalsProcessingInformation.md | 4 +- ...versalsReversalInformationAmountDetails.md | 4 +- ...sv2payoutsOrderInformationAmountDetails.md | 4 +- .../Model/Ptsv2payoutsRecipientInformation.md | 2 - ...ymentstatusidPaymentInformationCustomer.md | 2 +- ...01ResponseOrderInformationAmountDetails.md | 2 +- ...ushFunds201ResponseProcessorInformation.md | 6 +- docs/Model/PushFunds400Response.md | 2 +- docs/Model/PushFundsRequest.md | 7 +- ...Rbsv1plansOrderInformationAmountDetails.md | 2 +- ...1ResponseAddressVerificationInformation.md | 2 +- ...sponseConsumerAuthenticationInformation.md | 6 +- ...01ResponseOrderInformationAmountDetails.md | 2 +- ...isionsPost201ResponsePaymentInformation.md | 10 +- ...ionresultsOrderInformationAmountDetails.md | 4 +- .../Riskv1authenticationsBuyerInformation.md | 2 +- ...nticationsOrderInformationAmountDetails.md | 4 +- ...v1authenticationsOrderInformationBillTo.md | 2 +- docs/Model/Riskv1decisionsBuyerInformation.md | 6 +- ...isionsConsumerAuthenticationInformation.md | 2 +- ...1decisionsOrderInformationAmountDetails.md | 2 +- .../Riskv1decisionsOrderInformationBillTo.md | 2 +- ...onsProcessorInformationCardVerification.md | 2 +- ...mplianceinquiriesOrderInformationBillTo.md | 2 +- ...1liststypeentriesOrderInformationBillTo.md | 2 +- docs/Model/TmsEmbeddedInstrumentIdentifier.md | 4 +- ...beddedInstrumentIdentifierTokenizedCard.md | 1 + ...nsactionsGet200ResponseBuyerInformation.md | 4 +- ...sponseConsumerAuthenticationInformation.md | 4 +- ...00ResponseOrderInformationAmountDetails.md | 6 +- ...onsGet200ResponseOrderInformationBillTo.md | 4 +- ...onsGet200ResponsePaymentInformationBank.md | 10 +- ...00ResponsePaymentInformationBankAccount.md | 4 +- ...et200ResponsePaymentInformationCustomer.md | 2 +- ...ionsGet200ResponseProcessingInformation.md | 6 +- ...ocessingInformationAuthorizationOptions.md | 2 +- ...nformationElectronicVerificationResults.md | 8 +- ...Post201ResponseEmbeddedBuyerInformation.md | 2 +- ...beddedConsumerAuthenticationInformation.md | 4 +- ...1ResponseEmbeddedOrderInformationBillTo.md | 2 +- ...01ResponseEmbeddedProcessingInformation.md | 6 +- ...asV2TaxVoid200ResponseVoidAmountDetails.md | 2 +- docs/Model/Vasv2taxBuyerInformation.md | 2 +- .../Vasv2taxClientReferenceInformation.md | 2 +- .../Vasv2taxidClientReferenceInformation.md | 2 +- generator/cybersource-rest-spec.json | 1734 +++++++---------- ...sResponseOrderInformationAmountDetails.php | 2 +- ...t200ResponseInvoiceSettingsInformation.php | 2 +- ...esAllGet200ResponseCustomerInformation.php | 2 +- ...0ResponseOrderInformationAmountDetails.php | 4 +- ...voicesGet200ResponseTransactionDetails.php | 2 +- ...1ResponseOrderInformationAmountDetails.php | 4 +- ...oiceSettingsInvoiceSettingsInformation.php | 2 +- ...Invoicingv2invoicesCustomerInformation.php | 4 +- ...ngv2invoicesCustomerInformationCompany.php | 2 +- ...2invoicesOrderInformationAmountDetails.php | 4 +- ...esOrderInformationAmountDetailsFreight.php | 2 +- ...Kmsv2keyssymClientReferenceInformation.php | 2 +- .../PatchInstrumentIdentifierRequest.php | 8 +- ...tInstrumentIdentifierEnrollmentRequest.php | 8 +- lib/Model/PostInstrumentIdentifierRequest.php | 8 +- ...ditsPost201ResponseCreditAmountDetails.php | 2 +- ...ocessingInformationBankTransferOptions.php | 2 +- ...1ResponseOrderInformationAmountDetails.php | 2 +- ...BuyerInformationPersonalIdentification.php | 4 +- ...1ResponseOrderInformationAmountDetails.php | 2 +- ...Post201Response1OrderInformationBillTo.php | 2 +- ...Response2OrderInformationAmountDetails.php | 2 +- ...aymentsPost201ResponseBuyerInformation.php | 6 +- ...ponseConsumerAuthenticationInformation.php | 6 +- ...1ResponseOrderInformationAmountDetails.php | 4 +- ...mentsPost201ResponsePaymentInformation.php | 10 +- ...sPost201ResponsePaymentInformationBank.php | 2 +- ...1ResponsePaymentInformationBankAccount.php | 2 +- ...ocessingInformationBankTransferOptions.php | 4 +- ...nseProcessorInformationAchVerification.php | 4 +- ...seProcessorInformationCardVerification.php | 2 +- ...formationElectronicVerificationResults.php | 10 +- ...1ResponseOrderInformationAmountDetails.php | 4 +- ...fundPost201ResponseRefundAmountDetails.php | 2 +- ...lsPost201ResponseReversalAmountDetails.php | 2 +- ...sVoidsPost201ResponseVoidAmountDetails.php | 2 +- ...1ResponseOrderInformationAmountDetails.php | 4 +- ...pushfundstransferAggregatorInformation.php | 299 --- ...ansferAggregatorInformationSubMerchant.php | 461 ----- ...undstransferMerchantDefinedInformation.php | 272 --- ...v1pushfundstransferMerchantInformation.php | 326 ---- ...rMerchantInformationMerchantDescriptor.php | 407 ---- ...Ptsv1pushfundstransferOrderInformation.php | 64 +- ...stransferOrderInformationAmountDetails.php | 68 +- ...fundstransferOrderInformationSurcharge.php | 245 --- ...fundstransferPointOfServiceInformation.php | 353 ---- ...pushfundstransferProcessingInformation.php | 180 +- ...ferProcessingInformationPayoutsOptions.php | 52 +- ...rProcessingInformationRecurringOptions.php | 245 --- ...tsv1pushfundstransferProcessingOptions.php | 245 --- ...ransferProcessingOptionsFundingOptions.php | 245 --- ...ocessingOptionsFundingOptionsInitiator.php | 245 --- ...1pushfundstransferRecipientInformation.php | 70 +- ...pientInformationPaymentInformationCard.php | 2 +- ...pientInformationPersonalIdentification.php | 41 +- ...tsv1pushfundstransferSenderInformation.php | 43 +- ...hfundstransferSenderInformationAccount.php | 2 +- ...enderInformationPaymentInformationCard.php | 10 +- ...enderInformationPersonalIdentification.php | 41 +- ...billingagreementsAggregatorInformation.php | 2 +- ...Ptsv2billingagreementsBuyerInformation.php | 2 +- ...ngagreementsClientReferenceInformation.php | 2 +- ...illingagreementsOrderInformationBillTo.php | 2 +- ...sv2billingagreementsidBuyerInformation.php | 2 +- .../Ptsv2creditsProcessingInformation.php | 6 +- ...ocessingInformationBankTransferOptions.php | 6 +- ...Ptsv2paymentreferencesBuyerInformation.php | 2 +- ...eferencesOrderInformationAmountDetails.php | 6 +- ...aymentreferencesPaymentInformationBank.php | 2 +- ...eferencesPaymentInformationBankAccount.php | 2 +- .../Ptsv2paymentsAggregatorInformation.php | 4 +- lib/Model/Ptsv2paymentsBuyerInformation.php | 8 +- ...BuyerInformationPersonalIdentification.php | 6 +- ...tsv2paymentsClientReferenceInformation.php | 2 +- ...mentsConsumerAuthenticationInformation.php | 14 +- ...tsv2paymentsMerchantDefinedInformation.php | 4 +- ...2paymentsOrderInformationAmountDetails.php | 10 +- ...tionAmountDetailsAmexAdditionalAmounts.php | 2 +- .../Ptsv2paymentsOrderInformationBillTo.php | 2 +- ...2paymentsOrderInformationBillToCompany.php | 2 +- .../Ptsv2paymentsPaymentInformationBank.php | 6 +- ...2paymentsPaymentInformationBankAccount.php | 4 +- ...tsv2paymentsPaymentInformationCustomer.php | 2 +- .../Ptsv2paymentsProcessingInformation.php | 10 +- ...cessingInformationAuthorizationOptions.php | 4 +- ...formationAuthorizationOptionsInitiator.php | 2 +- ...sInitiatorMerchantInitiatedTransaction.php | 4 +- ...ocessingInformationBankTransferOptions.php | 10 +- lib/Model/Ptsv2paymentsTokenInformation.php | 37 +- ...formationTokenProvisioningInformation.php} | 8 +- ...aymentsidOrderInformationAmountDetails.php | 2 +- ...aymentsidcapturesAggregatorInformation.php | 4 +- ...tsv2paymentsidcapturesBuyerInformation.php | 6 +- ...BuyerInformationPersonalIdentification.php | 2 +- ...dcapturesOrderInformationAmountDetails.php | 10 +- ...ymentsidcapturesOrderInformationBillTo.php | 2 +- ...aymentsidcapturesProcessingInformation.php | 4 +- ...cessingInformationAuthorizationOptions.php | 4 +- ...ntsidrefundsClientReferenceInformation.php | 2 +- ...aymentsidrefundsPaymentInformationBank.php | 6 +- ...idrefundsPaymentInformationBankAccount.php | 2 +- ...paymentsidrefundsProcessingInformation.php | 4 +- ...sidreversalsClientReferenceInformation.php | 2 +- ...ymentsidreversalsProcessingInformation.php | 4 +- ...ersalsReversalInformationAmountDetails.php | 4 +- ...v2payoutsOrderInformationAmountDetails.php | 4 +- .../Ptsv2payoutsRecipientInformation.php | 64 +- ...mentstatusidPaymentInformationCustomer.php | 2 +- ...1ResponseOrderInformationAmountDetails.php | 2 +- ...shFunds201ResponseProcessorInformation.php | 58 +- lib/Model/PushFunds400Response.php | 2 +- lib/Model/PushFundsRequest.php | 151 +- ...bsv1plansOrderInformationAmountDetails.php | 2 +- ...ResponseAddressVerificationInformation.php | 2 +- ...ponseConsumerAuthenticationInformation.php | 6 +- ...1ResponseOrderInformationAmountDetails.php | 2 +- ...sionsPost201ResponsePaymentInformation.php | 10 +- ...onresultsOrderInformationAmountDetails.php | 4 +- .../Riskv1authenticationsBuyerInformation.php | 2 +- ...ticationsOrderInformationAmountDetails.php | 4 +- ...1authenticationsOrderInformationBillTo.php | 2 +- lib/Model/Riskv1decisionsBuyerInformation.php | 6 +- ...sionsConsumerAuthenticationInformation.php | 2 +- ...decisionsOrderInformationAmountDetails.php | 2 +- .../Riskv1decisionsOrderInformationBillTo.php | 2 +- ...nsProcessorInformationCardVerification.php | 2 +- ...plianceinquiriesOrderInformationBillTo.php | 2 +- ...liststypeentriesOrderInformationBillTo.php | 2 +- lib/Model/TmsEmbeddedInstrumentIdentifier.php | 8 +- ...eddedInstrumentIdentifierTokenizedCard.php | 27 + ...sactionsGet200ResponseBuyerInformation.php | 4 +- ...ponseConsumerAuthenticationInformation.php | 4 +- ...0ResponseOrderInformationAmountDetails.php | 6 +- ...nsGet200ResponseOrderInformationBillTo.php | 4 +- ...nsGet200ResponsePaymentInformationBank.php | 10 +- ...0ResponsePaymentInformationBankAccount.php | 4 +- ...t200ResponsePaymentInformationCustomer.php | 2 +- ...onsGet200ResponseProcessingInformation.php | 6 +- ...cessingInformationAuthorizationOptions.php | 2 +- ...formationElectronicVerificationResults.php | 8 +- ...ost201ResponseEmbeddedBuyerInformation.php | 2 +- ...eddedConsumerAuthenticationInformation.php | 4 +- ...ResponseEmbeddedOrderInformationBillTo.php | 2 +- ...1ResponseEmbeddedProcessingInformation.php | 6 +- ...sV2TaxVoid200ResponseVoidAmountDetails.php | 2 +- lib/Model/Vasv2taxBuyerInformation.php | 2 +- .../Vasv2taxClientReferenceInformation.php | 2 +- .../Vasv2taxidClientReferenceInformation.php | 2 +- ...erAggregatorInformationSubMerchantTest.php | 141 -- ...fundstransferAggregatorInformationTest.php | 99 - ...transferMerchantDefinedInformationTest.php | 92 - ...chantInformationMerchantDescriptorTest.php | 127 -- ...shfundstransferMerchantInformationTest.php | 106 - ...nsferOrderInformationAmountDetailsTest.php | 14 + ...stransferOrderInformationSurchargeTest.php | 85 - ...1pushfundstransferOrderInformationTest.php | 14 - ...stransferPointOfServiceInformationTest.php | 113 -- ...rocessingInformationPayoutsOptionsTest.php | 8 +- ...cessingInformationRecurringOptionsTest.php | 85 - ...fundstransferProcessingInformationTest.php | 42 - ...singOptionsFundingOptionsInitiatorTest.php | 85 - ...ferProcessingOptionsFundingOptionsTest.php | 85 - ...pushfundstransferProcessingOptionsTest.php | 85 - ...tInformationPersonalIdentificationTest.php | 7 + ...hfundstransferRecipientInformationTest.php | 14 - ...rInformationPersonalIdentificationTest.php | 7 + ...pushfundstransferSenderInformationTest.php | 7 - .../Ptsv2paymentsTokenInformationTest.php | 7 + ...ationTokenProvisioningInformationTest.php} | 12 +- .../Ptsv2payoutsRecipientInformationTest.php | 14 - ...nds201ResponseProcessorInformationTest.php | 14 - test/Model/PushFundsRequestTest.php | 35 - ...dInstrumentIdentifierTokenizedCardTest.php | 7 + 323 files changed, 1576 insertions(+), 6876 deletions(-) delete mode 100644 docs/Model/Ptsv1pushfundstransferAggregatorInformation.md delete mode 100644 docs/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md delete mode 100644 docs/Model/Ptsv1pushfundstransferMerchantDefinedInformation.md delete mode 100644 docs/Model/Ptsv1pushfundstransferMerchantInformation.md delete mode 100644 docs/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md delete mode 100644 docs/Model/Ptsv1pushfundstransferOrderInformationSurcharge.md delete mode 100644 docs/Model/Ptsv1pushfundstransferPointOfServiceInformation.md delete mode 100644 docs/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md delete mode 100644 docs/Model/Ptsv1pushfundstransferProcessingOptions.md delete mode 100644 docs/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md delete mode 100644 docs/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md rename docs/Model/{TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md => Ptsv2paymentsTokenInformationTokenProvisioningInformation.md} (94%) delete mode 100644 lib/Model/Ptsv1pushfundstransferAggregatorInformation.php delete mode 100644 lib/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.php delete mode 100644 lib/Model/Ptsv1pushfundstransferMerchantDefinedInformation.php delete mode 100644 lib/Model/Ptsv1pushfundstransferMerchantInformation.php delete mode 100644 lib/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.php delete mode 100644 lib/Model/Ptsv1pushfundstransferOrderInformationSurcharge.php delete mode 100644 lib/Model/Ptsv1pushfundstransferPointOfServiceInformation.php delete mode 100644 lib/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.php delete mode 100644 lib/Model/Ptsv1pushfundstransferProcessingOptions.php delete mode 100644 lib/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.php delete mode 100644 lib/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.php rename lib/Model/{TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.php => Ptsv2paymentsTokenInformationTokenProvisioningInformation.php} (95%) delete mode 100644 test/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchantTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferAggregatorInformationTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferMerchantDefinedInformationTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptorTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferMerchantInformationTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferOrderInformationSurchargeTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferPointOfServiceInformationTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptionsTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiatorTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsTest.php delete mode 100644 test/Model/Ptsv1pushfundstransferProcessingOptionsTest.php rename test/Model/{TmsEmbeddedInstrumentIdentifierTokenProvisioningInformationTest.php => Ptsv2paymentsTokenInformationTokenProvisioningInformationTest.php} (76%) diff --git a/docs/Api/TransactionBatchesApi.md b/docs/Api/TransactionBatchesApi.md index db63cde6c..e4ecbae8d 100644 --- a/docs/Api/TransactionBatchesApi.md +++ b/docs/Api/TransactionBatchesApi.md @@ -62,7 +62,7 @@ No authorization required Get Individual Batch File -Provide the search range +This API provides details like upload date, completion date, transaction count and accepted and rejected transaction count of the individual batch file using the batch id ### Example ```php @@ -107,7 +107,7 @@ No authorization required Get a List of Batch Files -Provide the search range +Provide the date and time search range to get a list of Batch Files ready for settlement ### Example ```php diff --git a/docs/Model/GetAllPlansResponseOrderInformationAmountDetails.md b/docs/Model/GetAllPlansResponseOrderInformationAmountDetails.md index 24db4bdc4..f9dd38869 100644 --- a/docs/Model/GetAllPlansResponseOrderInformationAmountDetails.md +++ b/docs/Model/GetAllPlansResponseOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **billingAmount** | **string** | Billing amount for the billing period. | [optional] **setupFee** | **string** | Subscription setup fee | [optional] diff --git a/docs/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md b/docs/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md index f9d34826e..1e9f65af0 100644 --- a/docs/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md +++ b/docs/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **enableReminders** | **bool** | Whether you would like us to send an auto-generated reminder email to your invoice recipients. Currently, this reminder email is sent five days before the invoice is due and one day after it is past due. | [optional] **headerStyle** | [**\CyberSource\Model\InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) | | [optional] **deliveryLanguage** | **string** | The language of the email that we send to your customers. Possible values are `zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`. | [optional] -**defaultCurrencyCode** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**defaultCurrencyCode** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **payerAuthentication3DSVersion** | **bool** | The 3D Secure payer authentication status for a merchant's invoice payments. | [optional] [default to false] **showVatNumber** | **bool** | Display VAT number on Invoice. | [optional] [default to false] **vatRegistrationNumber** | **string** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. | [optional] diff --git a/docs/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md b/docs/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md index 09cf362ed..740a7363b 100644 --- a/docs/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md +++ b/docs/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Payer name for the invoice. | [optional] -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md b/docs/Model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md index 9523b8d15..fafd7548c 100644 --- a/docs/Model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md +++ b/docs/Model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/InvoicingV2InvoicesGet200ResponseTransactionDetails.md b/docs/Model/InvoicingV2InvoicesGet200ResponseTransactionDetails.md index 0547b6aa3..df33f5c6a 100644 --- a/docs/Model/InvoicingV2InvoicesGet200ResponseTransactionDetails.md +++ b/docs/Model/InvoicingV2InvoicesGet200ResponseTransactionDetails.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transactionId** | **string** | Payer auth Transaction identifier. | [optional] -**amount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**amount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md b/docs/Model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md index eb8a41bbb..2ee420850 100644 --- a/docs/Model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md +++ b/docs/Model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **balanceAmount** | **string** | Remaining balance on the account. Returned by authorization service. #### PIN debit Remaining balance on the prepaid card. Returned by PIN debit purchase. | [optional] **discountAmount** | **string** | Total discount amount applied to the order. | [optional] **discountPercent** | **float** | The total discount percentage applied to the invoice. | [optional] diff --git a/docs/Model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md b/docs/Model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md index cf3257bdf..663128649 100644 --- a/docs/Model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md +++ b/docs/Model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **enableReminders** | **bool** | Whether you would like us to send an auto-generated reminder email to your invoice recipients. Currently, this reminder email is sent five days before the invoice is due and one day after it is past due. | [optional] **headerStyle** | [**\CyberSource\Model\InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) | | [optional] **deliveryLanguage** | **string** | The language of the email that we send to your customers. Possible values are `zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`. | [optional] -**defaultCurrencyCode** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**defaultCurrencyCode** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **payerAuthenticationInInvoicing** | **string** | For a merchant's invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are: - `enable` - `update` - `disable` | [optional] **showVatNumber** | **bool** | Display VAT number on Invoice. | [optional] [default to false] **vatRegistrationNumber** | **string** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. | [optional] diff --git a/docs/Model/Invoicingv2invoicesCustomerInformation.md b/docs/Model/Invoicingv2invoicesCustomerInformation.md index b974486a4..792c50623 100644 --- a/docs/Model/Invoicingv2invoicesCustomerInformation.md +++ b/docs/Model/Invoicingv2invoicesCustomerInformation.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Payer name for the invoice. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] **company** | [**\CyberSource\Model\Invoicingv2invoicesCustomerInformationCompany**](Invoicingv2invoicesCustomerInformationCompany.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Invoicingv2invoicesCustomerInformationCompany.md b/docs/Model/Invoicingv2invoicesCustomerInformationCompany.md index 4961ebded..aa0f83a8e 100644 --- a/docs/Model/Invoicingv2invoicesCustomerInformationCompany.md +++ b/docs/Model/Invoicingv2invoicesCustomerInformationCompany.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **string** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**name** | **string** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Invoicingv2invoicesOrderInformationAmountDetails.md b/docs/Model/Invoicingv2invoicesOrderInformationAmountDetails.md index 80d3a4d59..4fa601426 100644 --- a/docs/Model/Invoicingv2invoicesOrderInformationAmountDetails.md +++ b/docs/Model/Invoicingv2invoicesOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **discountAmount** | **string** | Total discount amount applied to the order. | [optional] **discountPercent** | **float** | The total discount percentage applied to the invoice. | [optional] **subAmount** | **float** | Sub-amount of the invoice. | [optional] diff --git a/docs/Model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md b/docs/Model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md index 55b37c48e..eb5da24a8 100644 --- a/docs/Model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md +++ b/docs/Model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **string** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**amount** | **string** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. | [optional] **taxable** | **bool** | Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include `invoiceDetails.taxable` in the data it sends to the processor. For processor-specific information, see the `tax_indicator` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - **true** - **false** | [optional] **taxRate** | **string** | Shipping Tax rate applied to the freight amount. **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional] diff --git a/docs/Model/Kmsv2keyssymClientReferenceInformation.md b/docs/Model/Kmsv2keyssymClientReferenceInformation.md index fccaa4161..4e840914c 100644 --- a/docs/Model/Kmsv2keyssymClientReferenceInformation.md +++ b/docs/Model/Kmsv2keyssymClientReferenceInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **string** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value. | [optional] -**comments** | **string** | Comments | [optional] +**comments** | **string** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**\CyberSource\Model\Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PatchInstrumentIdentifierRequest.md b/docs/Model/PatchInstrumentIdentifierRequest.md index f73b4fab4..18855880f 100644 --- a/docs/Model/PatchInstrumentIdentifierRequest.md +++ b/docs/Model/PatchInstrumentIdentifierRequest.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **string** | The Id of the Instrument Identifier Token. | [optional] **object** | **string** | The type. Possible Values: - instrumentIdentifier | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] -**type** | **string** | The type of Instrument Identifier. Possible Values: - enrollable card | [optional] -**tokenProvisioningInformation** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation**](TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md) | | [optional] +**type** | **string** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**tokenProvisioningInformation** | [**\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] **bankAccount** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional] diff --git a/docs/Model/PostInstrumentIdentifierEnrollmentRequest.md b/docs/Model/PostInstrumentIdentifierEnrollmentRequest.md index 12a4b1a5d..0fc62da63 100644 --- a/docs/Model/PostInstrumentIdentifierEnrollmentRequest.md +++ b/docs/Model/PostInstrumentIdentifierEnrollmentRequest.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **string** | The Id of the Instrument Identifier Token. | [optional] **object** | **string** | The type. Possible Values: - instrumentIdentifier | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] -**type** | **string** | The type of Instrument Identifier. Possible Values: - enrollable card | [optional] -**tokenProvisioningInformation** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation**](TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md) | | [optional] +**type** | **string** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**tokenProvisioningInformation** | [**\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] **bankAccount** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional] diff --git a/docs/Model/PostInstrumentIdentifierRequest.md b/docs/Model/PostInstrumentIdentifierRequest.md index e886f3b50..cdabeea56 100644 --- a/docs/Model/PostInstrumentIdentifierRequest.md +++ b/docs/Model/PostInstrumentIdentifierRequest.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **string** | The Id of the Instrument Identifier Token. | [optional] **object** | **string** | The type. Possible Values: - instrumentIdentifier | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] -**type** | **string** | The type of Instrument Identifier. Possible Values: - enrollable card | [optional] -**tokenProvisioningInformation** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation**](TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md) | | [optional] +**type** | **string** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**tokenProvisioningInformation** | [**\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] **bankAccount** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional] diff --git a/docs/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.md b/docs/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.md index b0e1eb2ea..b691f10ad 100644 --- a/docs/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.md +++ b/docs/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **creditAmount** | **string** | Amount that was credited to the cardholder's account. Returned by PIN debit credit. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md b/docs/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md index b1e5b2d83..66c4468bb 100644 --- a/docs/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md +++ b/docs/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settlementMethod** | **string** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**settlementMethod** | **string** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md b/docs/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md index 9baf8da5b..d967f1773 100644 --- a/docs/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md +++ b/docs/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalAmount** | **string** | Amount you requested for the capture. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **processorTransactionFee** | **string** | The fee decided by the PSP/Processor per transaction. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md b/docs/Model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md index 922ac3cee..d08a3028c 100644 --- a/docs/Model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md +++ b/docs/Model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **string** | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**id** | **string** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] +**type** | **string** | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. | [optional] +**id** | **string** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md b/docs/Model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md index ff7092b69..71886dd5d 100644 --- a/docs/Model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md +++ b/docs/Model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] **currency** | **string** | Currency used for the order | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201Response1OrderInformationBillTo.md b/docs/Model/PtsV2PaymentsPost201Response1OrderInformationBillTo.md index f99597321..f4568960a 100644 --- a/docs/Model/PtsV2PaymentsPost201Response1OrderInformationBillTo.md +++ b/docs/Model/PtsV2PaymentsPost201Response1OrderInformationBillTo.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **administrativeArea** | **string** | 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). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **postalCode** | **string** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional] **country** | **string** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **verificationStatus** | **string** | Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md b/docs/Model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md index c206b1fc0..bd40986a9 100644 --- a/docs/Model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md +++ b/docs/Model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201ResponseBuyerInformation.md b/docs/Model/PtsV2PaymentsPost201ResponseBuyerInformation.md index 8765886a0..b8c941443 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponseBuyerInformation.md +++ b/docs/Model/PtsV2PaymentsPost201ResponseBuyerInformation.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] +**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] +**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] **personalIdentification** | [**\CyberSource\Model\Ptsv2paymentsBuyerInformationPersonalIdentification[]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | | [optional] **taxId** | **string** | The description for this field is not available. | [optional] **loginId** | **string** | The buyer's Alipay login Id, the id might be an email or mobile number. The id is partially masked for privacy. cao***@126.com or 186***22156 | [optional] diff --git a/docs/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md b/docs/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md index 0b5c0cc00..3a7626de5 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md +++ b/docs/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **acsRenderingType** | **string** | Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. | [optional] **acsTransactionId** | **string** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional] **acsUrl** | **string** | URL for the card-issuing bank's authentication form that you receive when the card is enrolled. The value can be very large. | [optional] -**authenticationPath** | **string** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional] +**authenticationPath** | **string** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. | [optional] **authorizationPayload** | **string** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional] **authenticationTransactionId** | **string** | Payer authentication transaction identifier is used to link the check enrollment and validate authentication messages. For Rupay, this field should be passed as request only for Resend OTP use case. | [optional] **cardholderMessage** | **string** | Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder. For example, \"Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.\". The Issuing Bank can optionally support this value. | [optional] @@ -27,7 +27,7 @@ Name | Type | Description | Notes **networkScore** | **string** | The global score calculated by the CB scoring platform and returned to merchants. | [optional] **pareq** | **string** | Payer authentication request (PAReq) message that you need to forward to the ACS. The value can be very large. The value is in base64. | [optional] **paresStatus** | **string** | Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - `A`: Proof of authentication attempt was generated. - `N`: Customer failed or canceled authentication. Transaction denied. - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated. | [optional] -**proofXml** | **string** | Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. | [optional] +**proofXml** | **string** | Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. | [optional] **proxyPan** | **string** | Encrypted version of the card number used in the payer authentication request message. | [optional] **sdkTransactionId** | **string** | SDK unique transaction identifier that is generated on each new transaction. | [optional] **signedParesStatusReason** | **string** | Provides additional information as to why the PAResStatus has a specific value. | [optional] @@ -36,7 +36,7 @@ Name | Type | Description | Notes **threeDSServerTransactionId** | **string** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] **ucafAuthenticationData** | **string** | AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request. | [optional] **ucafCollectionIndicator** | **string** | For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - `0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication. | [optional] -**veresEnrolled** | **string** | Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional] +**veresEnrolled** | **string** | Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. | [optional] **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] diff --git a/docs/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md b/docs/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md index 0ef5f9a70..d03e3649b 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md +++ b/docs/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **totalAmount** | **string** | Amount you requested for the payment or capture. This value is returned for partial authorizations. This field is also returned on incremental authorizations will contain the aggregated amount from the original authorizations and all the incremental authorizations. | [optional] -**authorizedAmount** | **string** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**authorizedAmount** | **string** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **settlementAmount** | **string** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **string** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **originalAmount** | **string** | Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. | [optional] diff --git a/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformation.md b/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformation.md index 2069de103..34e6dbad3 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformation.md +++ b/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformation.md @@ -11,11 +11,11 @@ Name | Type | Description | Notes **paymentInstrument** | [**\CyberSource\Model\Ptsv2paymentsPaymentInformationPaymentInstrument**](Ptsv2paymentsPaymentInformationPaymentInstrument.md) | | [optional] **instrumentIdentifier** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier**](PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier.md) | | [optional] **shippingAddress** | [**\CyberSource\Model\Ptsv2paymentsPaymentInformationShippingAddress**](Ptsv2paymentsPaymentInformationShippingAddress.md) | | [optional] -**scheme** | **string** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**bin** | **string** | Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**accountType** | **string** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**issuer** | **string** | Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**binCountry** | **string** | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**scheme** | **string** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. | [optional] +**bin** | **string** | Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. | [optional] +**accountType** | **string** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. | [optional] +**issuer** | **string** | Name of the bank or entity that issued the card account. | [optional] +**binCountry** | **string** | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. | [optional] **eWallet** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponsePaymentInformationEWallet**](PtsV2PaymentsPost201ResponsePaymentInformationEWallet.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.md b/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.md index 3e17836da..b6a488779 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.md +++ b/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponsePaymentInformationBankAccount**](PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md) | | [optional] -**correctedRoutingNumber** | **string** | Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**correctedRoutingNumber** | **string** | Corrected account number from the ACH verification service. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md b/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md index be87fb29a..6c87a646d 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md +++ b/docs/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**correctedAccountNumber** | **string** | Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**correctedAccountNumber** | **string** | Corrected account number from the ACH verification service. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md b/docs/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md index c5b5fe725..0d59cbdcc 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md +++ b/docs/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settlementMethod** | **string** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**fraudScreeningLevel** | **string** | Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). | [optional] +**settlementMethod** | **string** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) | [optional] +**fraudScreeningLevel** | **string** | Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md b/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md index 66f8044ee..40b44090b 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md +++ b/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultCode** | **string** | Results from the ACH verification service. For details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). | [optional] -**resultCodeRaw** | **string** | Raw results from the ACH verification service. For details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). | [optional] +**resultCode** | **string** | Results from the ACH verification service. | [optional] +**resultCodeRaw** | **string** | Raw results from the ACH verification service. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md b/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md index 457fcaae8..39b571a67 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md +++ b/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultCode** | **string** | CVN result code. For details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**resultCode** | **string** | CVN result code. | [optional] **resultCodeRaw** | **string** | CVN result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of card verification. Use for debugging purposes only. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md b/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md index d43c745ac..0f518e6c0 100644 --- a/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md +++ b/docs/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **string** | Mapped Electronic Verification response code for the customer's name. For details, see `auth_ev_name` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**code** | **string** | Mapped Electronic Verification response code for the customer's name. | [optional] **codeRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's last name | [optional] -**email** | **string** | Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**email** | **string** | Mapped Electronic Verification response code for the customer's email address. | [optional] **emailRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's email address. | [optional] -**phoneNumber** | **string** | Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**phoneNumber** | **string** | Mapped Electronic Verification response code for the customer's phone number. | [optional] **phoneNumberRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's phone number. | [optional] -**postalCode** | **string** | Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**postalCode** | **string** | Mapped Electronic Verification response code for the customer's postal code. | [optional] **postalCodeRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's postal code. | [optional] -**street** | **string** | Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**street** | **string** | Mapped Electronic Verification response code for the customer's street address. | [optional] **streetRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's street address. | [optional] **name** | **string** | #### Visa Platform Connect Mapped Electronic Verification response code for the customer's name. Valid values : 'Y' Yes, the data Matches 'N' No Match 'O' Partial Match | [optional] **nameRaw** | **string** | #### Visa Platform Connect Raw Electronic Verification response code from the processor for the customer's name. Valid values : '01' Match '50' Partial Match '99' No Match | [optional] diff --git a/docs/Model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md b/docs/Model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md index beba002b9..2fb1030e9 100644 --- a/docs/Model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md +++ b/docs/Model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **settlementAmount** | **string** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **string** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] -**exchangeRate** | **string** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [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] -**foreignAmount** | **string** | Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**exchangeRate** | **string** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. | [optional] +**foreignAmount** | **string** | Set this field to the converted amount that was returned by the DCC provider. | [optional] **foreignCurrency** | **string** | Set this field to the converted amount that was returned by the DCC provider. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md b/docs/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md index a9308f9e4..82f1b540c 100644 --- a/docs/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md +++ b/docs/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **refundAmount** | **string** | Total amount of the refund. | [optional] **creditAmount** | **string** | Amount that was credited to the cardholder's account. Returned by PIN debit credit. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md b/docs/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md index a20018d9e..765fc2692 100644 --- a/docs/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md +++ b/docs/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reversedAmount** | **string** | Total reversed amount. Returned by authorization reversal. | [optional] **originalTransactionAmount** | **string** | Amount of the original transaction. Returned by authorization reversal and void. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md b/docs/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md index 0ff55165e..06ed00049 100644 --- a/docs/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md +++ b/docs/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **voidAmount** | **string** | Total amount of the void. #### PIN Debit Amount of the reversal. Returned by PIN debit reversal. | [optional] **originalTransactionAmount** | **string** | Amount of the original transaction. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md b/docs/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md index 371f17f48..d51971f16 100644 --- a/docs/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md +++ b/docs/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **settlementAmount** | **string** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **string** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] diff --git a/docs/Model/Ptsv1pushfundstransferAggregatorInformation.md b/docs/Model/Ptsv1pushfundstransferAggregatorInformation.md deleted file mode 100644 index 9a690b8b6..000000000 --- a/docs/Model/Ptsv1pushfundstransferAggregatorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Ptsv1pushfundstransferAggregatorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aggregatorId** | **string** | Value that identifies you as a payment aggregator. Get this value from the processor. FDC Compass This value must consist of uppercase letters. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - `Record`: CP01 TCR6 - `Position`: 95-105 - `Field`: Market Identifier / Payment Facilitator ID | [optional] -**name** | **string** | Your payment aggregator business name. Visa Platform COnnect With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in Credit Card Services Using the SCMP API. | [optional] -**subMerchant** | [**\CyberSource\Model\Ptsv1pushfundstransferAggregatorInformationSubMerchant**](Ptsv1pushfundstransferAggregatorInformationSubMerchant.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md b/docs/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md deleted file mode 100644 index 49e8ff0b7..000000000 --- a/docs/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md +++ /dev/null @@ -1,18 +0,0 @@ -# Ptsv1pushfundstransferAggregatorInformationSubMerchant - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **string** | The ID you assigned to your sub-merchant. FDC Compass: This value must consist of uppercase characters. Visa Platform Connect with Mastercard: String (15) FDC Compass: String (20) | [optional] -**name** | **string** | Sub-merchant's business name. Visa Platform Connect With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional] -**address1** | **string** | First line of the sub-merchant's street address. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional] -**locality** | **string** | Sub-merchant's city. For processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional] -**administrativeArea** | **string** | Sub-merchant's state or province. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. | [optional] -**postalCode** | **string** | Partial postal code for the sub-merchant's address. For processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional] -**country** | **string** | Sub-merchant's country. Use the ISO Standard numeric Country Codes. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. | [optional] -**email** | **string** | Sub-merchant's email address. CyberSource through VisaNet | With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address - Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**phoneNumber** | **string** | Sub-merchant's telephone number. Maximum length for procesors Visa Platform Connect: 20 FDC Compass: 13 FDC Compass This value must consist of uppercase characters. Use one of these recommended formats: NNN-NNN-NNNN NNN-AAAAAAA | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferMerchantDefinedInformation.md b/docs/Model/Ptsv1pushfundstransferMerchantDefinedInformation.md deleted file mode 100644 index e60045662..000000000 --- a/docs/Model/Ptsv1pushfundstransferMerchantDefinedInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Ptsv1pushfundstransferMerchantDefinedInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **string** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference merchantDefinedInformation[1].key. For Mastercard Send: Name to be displayed in the reconciliation report for this disbursement. This value will appear as a header in the column name of the report. | [optional] -**value** | **string** | The value you assign for your merchant-defined data field. For details, see merchant_defined_data1 field description in the Credit Card Services Using the SCMP API Guide. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. For Mastercard Send: Value to be displayed in the reconciliation report for this disbursement. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferMerchantInformation.md b/docs/Model/Ptsv1pushfundstransferMerchantInformation.md deleted file mode 100644 index 0f6547191..000000000 --- a/docs/Model/Ptsv1pushfundstransferMerchantInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Ptsv1pushfundstransferMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categoryCode** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR4 Position: 150-153 Field: Merchant Category Code | [optional] -**submitLocalDateTime** | **string** | Time that the transaction was submitted in local time. The time is in hhmmss format. | [optional] -**vatRegistrationNumber** | **string** | Your government-assigned tax identification number. Visa Platform Connect: max length is 20 | [optional] -**merchantDescriptor** | [**\CyberSource\Model\Ptsv1pushfundstransferMerchantInformationMerchantDescriptor**](Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md b/docs/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md deleted file mode 100644 index 6bf483343..000000000 --- a/docs/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,16 +0,0 @@ -# Ptsv1pushfundstransferMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**administrativeArea** | **string** | The state where the merchant is located. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Note This field is supported only for businesses located in the U.S. or Canada. | [optional] -**contact** | **string** | For the descriptions, used-by information, data types, and lengths for these fields, see merchant_descriptor_contact field description in Credit Card Services Using the SCMP API.--> Contact information for the merchant. Note These are the maximum data lengths for the following payment processors: FDC Compass (13) Chase Paymentech (13). | [optional] -**country** | **string** | Merchant's country. Country code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder's statement. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Note If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea. | [optional] -**locality** | **string** | Merchant's City. City for your business location. This value might be displayed on the cardholder's statement. | [optional] -**name** | **string** | Merchant's business name. This name is displayed on the cardholder's statement. Chase Paymentech, Visa Platform Connect: length 22 | [optional] -**storeId** | **string** | The unique id of the merchant's shop which assigned by the merchant. | [optional] -**postalCode** | **string** | Merchant's postal code. This value might be displayed on the cardholder's statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789 If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3 | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferOrderInformation.md b/docs/Model/Ptsv1pushfundstransferOrderInformation.md index 012357e25..44e071ede 100644 --- a/docs/Model/Ptsv1pushfundstransferOrderInformation.md +++ b/docs/Model/Ptsv1pushfundstransferOrderInformation.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **amountDetails** | [**\CyberSource\Model\Ptsv1pushfundstransferOrderInformationAmountDetails**](Ptsv1pushfundstransferOrderInformationAmountDetails.md) | | -**isCryptocurrencyPurchase** | **string** | This indicates that the funds transfer is for a crypto currency transaction. Optional Y/y, true N/n, false | [optional] -**surcharge** | [**\CyberSource\Model\Ptsv1pushfundstransferOrderInformationSurcharge**](Ptsv1pushfundstransferOrderInformationSurcharge.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv1pushfundstransferOrderInformationAmountDetails.md b/docs/Model/Ptsv1pushfundstransferOrderInformationAmountDetails.md index a22fca945..19c8afa4b 100644 --- a/docs/Model/Ptsv1pushfundstransferOrderInformationAmountDetails.md +++ b/docs/Model/Ptsv1pushfundstransferOrderInformationAmountDetails.md @@ -3,8 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. The disbursement amount. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant currency exponent. For example, a US Dollar $53 amount is a value of 5300. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.99 Chase Paymentech: .01-9999999999.99 | -**currency** | **string** | Use a 3-character alpha currency code for currency of the sender. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. | +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. | +**currency** | **string** | Use a 3-character alpha currency code for currency of the funds transfer. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. | +**sourceCurrency** | **string** | Use a 3-character alpha currency code for source currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf | [optional] +**destinationCurrency** | **string** | Use a 3-character alpha currency code for destination currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf NOTE: This field is supported only for Visa Platform Connect | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv1pushfundstransferOrderInformationSurcharge.md b/docs/Model/Ptsv1pushfundstransferOrderInformationSurcharge.md deleted file mode 100644 index c933ebdb1..000000000 --- a/docs/Model/Ptsv1pushfundstransferOrderInformationSurcharge.md +++ /dev/null @@ -1,10 +0,0 @@ -# Ptsv1pushfundstransferOrderInformationSurcharge - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount** | **string** | The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer. NOTE: This field is supported only for Visa Platform Connect | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferPointOfServiceInformation.md b/docs/Model/Ptsv1pushfundstransferPointOfServiceInformation.md deleted file mode 100644 index 9f74f4a97..000000000 --- a/docs/Model/Ptsv1pushfundstransferPointOfServiceInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# Ptsv1pushfundstransferPointOfServiceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminalId** | **string** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. Visa Platform Connect 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. 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. Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include pointOfSaleInformation.catLevel. | [optional] -**catLevel** | **int** | 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. Visa Platform COnnect Values 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values. Optional field. 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. | [optional] -**pinEntryCapability** | **int** | PIN Entry Capability - 0 Unknown. - 1 Indicates terminal can accept and forward online PINs. - 2 Indicates terminal cannot accept and forward online PINs. - 8 Terminal PIN pad down. - 9 Reserved for future use. | [optional] -**terminalCapability** | **int** | integer [ 1 .. 5 ] 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. Used by Authorization Required for the following processors: Chase Paymentech Solutions Optional for the following processors: Visa Platform Connect | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferProcessingInformation.md b/docs/Model/Ptsv1pushfundstransferProcessingInformation.md index e45b4bac6..9f25259a3 100644 --- a/docs/Model/Ptsv1pushfundstransferProcessingInformation.md +++ b/docs/Model/Ptsv1pushfundstransferProcessingInformation.md @@ -3,14 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**businessApplicationId** | **string** | Payouts transaction type. Required for Mastercard Send. Valid Values- Visa Platform Connect: - `AA`: Account to account. - `CP`: Card bill payment - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. - `TU`: Top-up for enhanced prepaid loads. Mastercard Send: - `BB`: Business to business. - `BD`: Business Disbursement - `CP`: Card bill payment - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `OG`: Online gambling payout. Chase Paymentech Solutions: - `AA`: Account to account. - `FD`: Funds disbursement (general) - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. FDC Compass: - `BB`: Business to business. - `BI`: Bank-initiated money transfer. - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `GP`: Gambling Payment - `LO`: Loyalty Offers - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `MI`: Merchant initated money transfer - `OG`: Online gambling payout. - `PD`: Payroll pension disbursement. - `PP`: Person to person. - `WT`: Wallet transfer. | [optional] -**commerceIndicator** | **string** | Type of transaction. Value for an OCT transaction: internet For details, see the e_commerce_indicator field description in Payouts Using the SCMP API. | -**networkRoutingOrder** | **string** | Visa Platform Connect This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. For details, see the network_order field description in BIN Lookup Service Using the SCMP API. | [optional] +**businessApplicationId** | **string** | Payouts transaction type. Business Application ID: - `PP`: Person to person. - `FD`: Funds disbursement (general) | [optional] **payoutsOptions** | [**\CyberSource\Model\Ptsv1pushfundstransferProcessingInformationPayoutsOptions**](Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md) | | [optional] -**purposeOfPayment** | **string** | This will send purpose of funds code for original credit transactions (OCTs). Visa Platform Connect (VPC) This will send purpose of transaction code for original credit transactions (OCTs). Purpose of Payment codes are defined by the recipient issuer's country and vary by country. Mastercard Send: - `00`: Family Support - `01`: Regular Labor Transfers (expatriates), - `02`: Travel & Tourism - `03`: Education - `04`: Hospitalization & Medical Treatment, - `05`: Emergency Need - `06`: Savings - `07`: Gifts - `08`: Other - `09`: Salary - `10`: Crowd lending - `11`: Crypto currency - `12`: Refund to original card - `13`: Refund to new card | [optional] -**reconciliationId** | **string** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. For Payouts: max length for FDCCompass is String (22). | [optional] -**recurringOptions** | [**\CyberSource\Model\Ptsv1pushfundstransferProcessingInformationRecurringOptions**](Ptsv1pushfundstransferProcessingInformationRecurringOptions.md) | | [optional] -**transactionReason** | **string** | Transaction reason code. This field applies only to Visa Platform Connect | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md b/docs/Model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md index 989e2ca98..146d60947 100644 --- a/docs/Model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md +++ b/docs/Model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accountFundingReferenceId** | **string** | Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request. Applicable only for Visa Platform Connect | [optional] -**retrievalReferenceNumber** | **string** | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Format: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 – 366. Positions 5-12: A unique identification number generated by the merchant Applicable only for Visa Platform Connect | [optional] +**sourceCurrency** | **string** | Use a 3-character alpha currency code for source currency of the funds transfer. Yellow Pepper Supported for cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf | [optional] +**destinationCurrency** | **string** | Use a 3-character alpha currency code for destination currency of the funds transfer. Yellow Pepper Supported for cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md b/docs/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md deleted file mode 100644 index 6385f79d9..000000000 --- a/docs/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# Ptsv1pushfundstransferProcessingInformationRecurringOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**loanPayment** | **bool** | boolean Default: false Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: true: Loan payment false: (default) Not a loan payment This field applies only to FDC Compass | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferProcessingOptions.md b/docs/Model/Ptsv1pushfundstransferProcessingOptions.md deleted file mode 100644 index 976a94659..000000000 --- a/docs/Model/Ptsv1pushfundstransferProcessingOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# Ptsv1pushfundstransferProcessingOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fundingOptions** | [**\CyberSource\Model\Ptsv1pushfundstransferProcessingOptionsFundingOptions**](Ptsv1pushfundstransferProcessingOptionsFundingOptions.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md b/docs/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md deleted file mode 100644 index 298b05e17..000000000 --- a/docs/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# Ptsv1pushfundstransferProcessingOptionsFundingOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**initiator** | [**\CyberSource\Model\Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator**](Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md b/docs/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md deleted file mode 100644 index 50f31ca5b..000000000 --- a/docs/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md +++ /dev/null @@ -1,10 +0,0 @@ -# Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **string** | Visa Platform Connect : This API will contain a code that denotes whether the customer identification data belongs to the sender or the recipient. The valid values are: - `S` (Payer (sender)) - `R` (Payee (recipient)) This field applies only to Visa Platform Connect | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Model/Ptsv1pushfundstransferRecipientInformation.md b/docs/Model/Ptsv1pushfundstransferRecipientInformation.md index 3ebe3dd76..e705fdedf 100644 --- a/docs/Model/Ptsv1pushfundstransferRecipientInformation.md +++ b/docs/Model/Ptsv1pushfundstransferRecipientInformation.md @@ -4,17 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paymentInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferRecipientInformationPaymentInformation**](Ptsv1pushfundstransferRecipientInformationPaymentInformation.md) | | [optional] -**address1** | **string** | First line of the recipient's address. Required for Mastercard Send. This field is not supported for Visa Platform Connect. | [optional] -**address2** | **string** | Second line of the recipient's address Optional for Mastercard Send. This field is not supported for Visa Platform Connect. | [optional] -**locality** | **string** | Recipient city. Required for Mastercard Send. | [optional] -**postalCode** | **string** | Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Mastercard Send: Required for recipients in Canada and Canadian issued cards. | [optional] -**administrativeArea** | **string** | The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. Required only for FDCCompass. This field is not supported for Visa Platform Connect. | [optional] -**country** | **string** | Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Required for Mastercard Send. | [optional] -**firstName** | **string** | First name of recipient. Visa Platform Connect (14) Chase Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. | [optional] +**address1** | **string** | First line of the recipient's address. Required for card payments | [optional] +**address2** | **string** | Second line of the recipient's address | [optional] +**locality** | **string** | Recipient city. | [optional] +**postalCode** | **string** | Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Mandatory for card payments. | [optional] +**administrativeArea** | **string** | The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Required for card payments. | [optional] +**country** | **string** | Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf | [optional] +**firstName** | **string** | First name of recipient. | [optional] **middleName** | **string** | Sender's middle name. This field is a passthrough, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] -**middleInitial** | **string** | Middle Initial of recipient. This field is supported by FDC Compass. | [optional] -**lastName** | **string** | Last name of recipient. Visa Platform Connect (14) Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. | [optional] -**dateOfBirth** | **string** | Recipient date of birth in YYYYMMDD format. | [optional] +**lastName** | **string** | Last name of recipient. | [optional] **phoneNumber** | **string** | Recipient phone number. This field is supported by FDC Compass. Mastercard Send: Max length is 15 with no dashes or spaces. | [optional] **personalIdentification** | [**\CyberSource\Model\Ptsv1pushfundstransferRecipientInformationPersonalIdentification**](Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md) | | [optional] diff --git a/docs/Model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md b/docs/Model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md index 268bb924c..fdfae5c1e 100644 --- a/docs/Model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md +++ b/docs/Model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **string** | Three-digit value that indicates the card type. Mandatory if not present in a token. Possible values: Visa Platform Connect - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `033`: Visa Electron - `024`: Maestro Mastercard Send: - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. FDC Compass: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Chase Paymentech: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. | [optional] +**type** | **string** | Three-digit value that indicates the card type. Possible values: Visa Platform Connect - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `033`: Visa Electron - `024`: Maestro Mastercard Send: - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. FDC Compass: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Chase Paymentech: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Yellow Pepper: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `005`: Diners Club - `033`: Visa Electron - `024`: Intl Maestro | [optional] **securityCode** | **string** | 3-digit value that indicates the cardCvv2Value. Values can be 0-9. | [optional] **number** | **string** | The customer's payment card number, also known as the Primary Account Number (PAN). Conditional: this field is required if not using tokens. | [optional] **expirationMonth** | **string** | Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. | [optional] diff --git a/docs/Model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md b/docs/Model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md index 04a4dd991..a048077d6 100644 --- a/docs/Model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md +++ b/docs/Model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **string** | The ID number/value. 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. Mastercard Send(80) | [optional] -**type** | **string** | This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `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) Mastercard Send: - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `EIDN`: (Employer Identification Number) - `IDNB`: (Identity Card Number) | [optional] +**id** | **string** | The ID number/value. Processor(35) | [optional] +**type** | **string** | This tag will contain the type of sender identification. | [optional] +**issuingCountry** | **string** | Issuing country of the identification. The field format should be a 2 character ISO 3166-1 alpha-2 country code. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv1pushfundstransferSenderInformation.md b/docs/Model/Ptsv1pushfundstransferSenderInformation.md index c7f6ea376..c64a0c7db 100644 --- a/docs/Model/Ptsv1pushfundstransferSenderInformation.md +++ b/docs/Model/Ptsv1pushfundstransferSenderInformation.md @@ -4,16 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of sender. Funds Disbursement This value is the name of the originator sending the funds disbursement. | [optional] -**firstName** | **string** | This field contains the first name of the entity funding the transaction. | [optional] -**lastName** | **string** | This field contains the last name of the entity funding the transaction. | [optional] -**middleName** | **string** | Supported only for Mastercard transactions. This field contains the middle name of the entity funding the transaction | [optional] +**firstName** | **string** | This field contains the first name of the entity funding the transaction Mandatory for card payments | [optional] +**lastName** | **string** | This field contains the last name of the entity funding the transaction Mandatory for card payments | [optional] +**middleName** | **string** | This field contains the middle name of the entity funding the transaction | [optional] **postalCode** | **string** | Sender's postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Required for FDCCompass. | [optional] -**address1** | **string** | Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. | [optional] -**address2** | **string** | Used for additional address information. For example: Attention: Accounts Payable Optional field. This field is supported for only Mastercard Send. | [optional] -**locality** | **string** | The sender's city Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. | [optional] -**administrativeArea** | **string** | Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf | [optional] -**country** | **string** | Sender's country code. Use ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. Required for Mastercard Send | [optional] -**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. | [optional] +**address1** | **string** | Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Required for card transactions | [optional] +**address2** | **string** | Used for additional address information. For example: Attention: Accounts Payable Optional field. | [optional] +**locality** | **string** | The sender's city Mandatory for card payments | [optional] +**administrativeArea** | **string** | Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Mandatory for card payments | [optional] +**country** | **string** | Sender's country code. Use ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf | [optional] **dateOfBirth** | **string** | Sender's date of birth in YYYYMMDD format. | [optional] **phoneNumber** | **string** | Sender's phone number. | [optional] **paymentInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferSenderInformationPaymentInformation**](Ptsv1pushfundstransferSenderInformationPaymentInformation.md) | | [optional] diff --git a/docs/Model/Ptsv1pushfundstransferSenderInformationAccount.md b/docs/Model/Ptsv1pushfundstransferSenderInformationAccount.md index 7359dea00..c86b1e740 100644 --- a/docs/Model/Ptsv1pushfundstransferSenderInformationAccount.md +++ b/docs/Model/Ptsv1pushfundstransferSenderInformationAccount.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fundsSource** | **string** | Source of funds. Possible values: Chase Paymentech, FDC Compass, Visa Platform Connect: - `01`: Credit card - `02`: Debit card - `03`: Prepaid card Chase Paymentech, Visa Platform Connect: - `04`: Cash - `05`: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, and proprietary debit or ATM cards. - `06`: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit. FDC Compass: - `04`: Deposit Account Funds Disbursement This value is most likely 05 to identify that the originator used a deposit account to fund the disbursement. Credit Card Bill Payment This value must be 02, 03, 04, or 05. | [optional] -**number** | **string** | The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. Funds disbursements This field is optional. All other transactions This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: FDC Compass (<= 19) Chase Paymentech (<= 16) | [optional] +**number** | **string** | The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. Funds disbursements This field is optional. All other transactions This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md b/docs/Model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md index e75d037e8..c2db7b9ed 100644 --- a/docs/Model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md +++ b/docs/Model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **string** | Three-digit value that indicates the card type. IMPORTANT It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `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. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. | [optional] -**securityCode** | **string** | 3-digit value that indicates the card Cvv2Value. Values can be 0-9. This field is supported in Mastercard Send. | [optional] -**sourceAccountType** | **string** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Valid values for Visa Platform Connect: - `CHECKING`: Checking account - `CREDIT`: Credit card account - `SAVING`: Saving account - `LINE_OF_CREDIT`: Line of credit or credit portion of combo card - `PREPAID`: Prepaid card account or prepaid portion of combo card - `UNIVERSAL`: Universal account Valid values for Mastercard Send: - `00`: Other, - `01`: RTN + Bank Account, - `02`: IBAN, - `03`: Card Account, - `04`: Email, - `05`: Phone Number, - `06`: Bank account number (BAN) + Bank Identification Сode (BIC), - `07`: Wallet ID, - `08`: Social Network ID. Numeric, 2 characters. This field is supported in Mastercard Send. | [optional] -**number** | **string** | The customer's payment card number, also known as the Primary Account Number (PAN). This field is supported in Mastercard Send. | [optional] -**expirationMonth** | **string** | Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. This field is supported for Mastercard Send. | [optional] -**expirationYear** | **string** | Four-digit year in which the payment card expires. This field is supported for Mastercard Send. | [optional] +**securityCode** | **string** | 3-digit value that indicates the card Cvv2Value. Values can be 0-9. | [optional] +**sourceAccountType** | **string** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. | [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. Valid values: 01 through 12. Leading 0 is required. | [optional] +**expirationYear** | **string** | Four-digit year in which the payment card expires. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md b/docs/Model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md index 2cf75484c..f60e1799a 100644 --- a/docs/Model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md +++ b/docs/Model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md @@ -3,9 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **string** | Visa Platform Connect(35) This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender. Mastercard Send(80) | [optional] +**id** | **string** | Processor(35) | [optional] **personalIdType** | **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] -**type** | **string** | This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `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) Mastercard Send: - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `EIDN`: (Employer Identification Number) - `IDNB`: (Identity Card Number) | [optional] +**type** | **string** | This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `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] +**issuingCountry** | **string** | Issuing country of the identification. The field format should be a 2 character ISO 3166-1 alpha-2 country code. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2billingagreementsAggregatorInformation.md b/docs/Model/Ptsv2billingagreementsAggregatorInformation.md index 8feead934..2911d0750 100644 --- a/docs/Model/Ptsv2billingagreementsAggregatorInformation.md +++ b/docs/Model/Ptsv2billingagreementsAggregatorInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **string** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**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** | [**\CyberSource\Model\Ptsv2paymentsAggregatorInformationSubMerchant**](Ptsv2paymentsAggregatorInformationSubMerchant.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2billingagreementsBuyerInformation.md b/docs/Model/Ptsv2billingagreementsBuyerInformation.md index 2297a378f..6386a1d32 100644 --- a/docs/Model/Ptsv2billingagreementsBuyerInformation.md +++ b/docs/Model/Ptsv2billingagreementsBuyerInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### SEPA/BACS Required for Create Mandate and Import Mandate #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [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] **gender** | **string** | Customer's gender. Possible values are F (female), M (male), O (other). | [optional] **language** | **string** | language setting of the user | [optional] diff --git a/docs/Model/Ptsv2billingagreementsClientReferenceInformation.md b/docs/Model/Ptsv2billingagreementsClientReferenceInformation.md index b6a546faa..18b6360b1 100644 --- a/docs/Model/Ptsv2billingagreementsClientReferenceInformation.md +++ b/docs/Model/Ptsv2billingagreementsClientReferenceInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **reconciliationId** | **string** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. | [optional] **pausedRequestId** | **string** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional] **transactionId** | **string** | Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. | [optional] -**comments** | **string** | Comments | [optional] +**comments** | **string** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**\CyberSource\Model\Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [optional] **applicationName** | **string** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] **applicationVersion** | **string** | Version of the CyberSource application or integration used for a transaction. | [optional] diff --git a/docs/Model/Ptsv2billingagreementsOrderInformationBillTo.md b/docs/Model/Ptsv2billingagreementsOrderInformationBillTo.md index 1283a7aaf..c32ccb475 100644 --- a/docs/Model/Ptsv2billingagreementsOrderInformationBillTo.md +++ b/docs/Model/Ptsv2billingagreementsOrderInformationBillTo.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **country** | **string** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **county** | **string** | U.S. county if available. | [optional] **district** | **string** | Customer's neighborhood, community, or region within the city or municipality. #### SEPA/BACS When you include this field in a request, the value for this field must be the same as the value for the billTo_state field. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **firstName** | **string** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **middleName** | **string** | Customer's middle name. | [optional] **lastName** | **string** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] diff --git a/docs/Model/Ptsv2billingagreementsidBuyerInformation.md b/docs/Model/Ptsv2billingagreementsidBuyerInformation.md index c1dcf7f8b..c782f5a91 100644 --- a/docs/Model/Ptsv2billingagreementsidBuyerInformation.md +++ b/docs/Model/Ptsv2billingagreementsidBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [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] **gender** | **string** | Customer's gender. Possible values are F (female), M (male), O (other). | [optional] **language** | **string** | language setting of the user | [optional] diff --git a/docs/Model/Ptsv2creditsProcessingInformation.md b/docs/Model/Ptsv2creditsProcessingInformation.md index aef06019d..71e94b3d1 100644 --- a/docs/Model/Ptsv2creditsProcessingInformation.md +++ b/docs/Model/Ptsv2creditsProcessingInformation.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commerceIndicator** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**commerceIndicator** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] **processorId** | **string** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field. | [optional] **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 SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `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] **reconciliationId** | **string** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] +**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **string** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **purchaseLevel** | **string** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **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] diff --git a/docs/Model/Ptsv2creditsProcessingInformationBankTransferOptions.md b/docs/Model/Ptsv2creditsProcessingInformationBankTransferOptions.md index 3488b17fa..2afa2f838 100644 --- a/docs/Model/Ptsv2creditsProcessingInformationBankTransferOptions.md +++ b/docs/Model/Ptsv2creditsProcessingInformationBankTransferOptions.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **customerMemo** | **string** | Payment related information. This information is included on the customer's statement. | [optional] -**secCode** | **string** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**secCode** | **string** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry | [optional] **terminalCity** | **string** | City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **terminalState** | **string** | State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **effectiveDate** | **string** | Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day. Format: `MMDDYYYY` Supported only for the CyberSource ACH Service. | [optional] -**partialPaymentId** | **string** | Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**settlementMethod** | **string** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**partialPaymentId** | **string** | Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. | [optional] +**settlementMethod** | **string** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentreferencesBuyerInformation.md b/docs/Model/Ptsv2paymentreferencesBuyerInformation.md index d482cb85e..93e106db9 100644 --- a/docs/Model/Ptsv2paymentreferencesBuyerInformation.md +++ b/docs/Model/Ptsv2paymentreferencesBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [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] **gender** | **string** | Customer's gender. Possible values are F (female), M (male),O (other). | [optional] **language** | **string** | language setting of the user | [optional] **noteToSeller** | **string** | Note to the recipient of the funds in this transaction | [optional] diff --git a/docs/Model/Ptsv2paymentreferencesOrderInformationAmountDetails.md b/docs/Model/Ptsv2paymentreferencesOrderInformationAmountDetails.md index df2780747..9bf9b6e31 100644 --- a/docs/Model/Ptsv2paymentreferencesOrderInformationAmountDetails.md +++ b/docs/Model/Ptsv2paymentreferencesOrderInformationAmountDetails.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **discountAmount** | **string** | Total discount amount applied to the order. | [optional] **taxAmount** | **string** | Total tax amount for all the items in the order. | [optional] **dutyAmount** | **string** | Total charges for any import or export duties included in the order. | [optional] -**exchangeRate** | **string** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [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] +**exchangeRate** | **string** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. | [optional] **exchangeRateTimeStamp** | **string** | Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. | [optional] **settlementCurrency** | **string** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **giftwrapAmount** | **string** | giftwrap amount (RFU). | [optional] diff --git a/docs/Model/Ptsv2paymentreferencesPaymentInformationBank.md b/docs/Model/Ptsv2paymentreferencesPaymentInformationBank.md index 722121f52..0f5d8edf6 100644 --- a/docs/Model/Ptsv2paymentreferencesPaymentInformationBank.md +++ b/docs/Model/Ptsv2paymentreferencesPaymentInformationBank.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**swiftCode** | **string** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**swiftCode** | **string** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] **account** | [**\CyberSource\Model\Ptsv2paymentreferencesPaymentInformationBankAccount**](Ptsv2paymentreferencesPaymentInformationBankAccount.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentreferencesPaymentInformationBankAccount.md b/docs/Model/Ptsv2paymentreferencesPaymentInformationBankAccount.md index da1a0fc19..7755bc126 100644 --- a/docs/Model/Ptsv2paymentreferencesPaymentInformationBankAccount.md +++ b/docs/Model/Ptsv2paymentreferencesPaymentInformationBankAccount.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **number** | **string** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] -**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsAggregatorInformation.md b/docs/Model/Ptsv2paymentsAggregatorInformation.md index ed9dbe5bf..232dd16e0 100644 --- a/docs/Model/Ptsv2paymentsAggregatorInformation.md +++ b/docs/Model/Ptsv2paymentsAggregatorInformation.md @@ -3,8 +3,8 @@ ## Properties 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. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**name** | **string** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**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** | [**\CyberSource\Model\Ptsv2paymentsAggregatorInformationSubMerchant**](Ptsv2paymentsAggregatorInformationSubMerchant.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsBuyerInformation.md b/docs/Model/Ptsv2paymentsBuyerInformation.md index d070cbb6d..551b01ff6 100644 --- a/docs/Model/Ptsv2paymentsBuyerInformation.md +++ b/docs/Model/Ptsv2paymentsBuyerInformation.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] +**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] +**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] **companyTaxId** | **string** | Company's tax identifier. This is only used for eCheck service. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. | [optional] **personalIdentification** | [**\CyberSource\Model\Ptsv2paymentsBuyerInformationPersonalIdentification[]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | | [optional] -**hashedPassword** | **string** | The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**hashedPassword** | **string** | The merchant's password that CyberSource hashes and stores as a hashed password. | [optional] **gender** | **string** | Customer's gender. Possible values are F (female), M (male),O (other). | [optional] **language** | **string** | language setting of the user | [optional] **noteToSeller** | **string** | Note to the recipient of the funds in this transaction | [optional] diff --git a/docs/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.md b/docs/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.md index 1b218cce6..5f3e4f5a3 100644 --- a/docs/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.md +++ b/docs/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **string** | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**id** | **string** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] -**issuedBy** | **string** | The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. For details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) For details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**type** | **string** | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. | [optional] +**id** | **string** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] +**issuedBy** | **string** | The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. | [optional] **verificationResults** | **string** | Verification results received from Issuer or Card Network for verification transactions. Response Only Field. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsClientReferenceInformation.md b/docs/Model/Ptsv2paymentsClientReferenceInformation.md index d0f23bb08..eab8d733f 100644 --- a/docs/Model/Ptsv2paymentsClientReferenceInformation.md +++ b/docs/Model/Ptsv2paymentsClientReferenceInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **reconciliationId** | **string** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. | [optional] **pausedRequestId** | **string** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional] **transactionId** | **string** | Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. | [optional] -**comments** | **string** | Comments | [optional] +**comments** | **string** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**\CyberSource\Model\Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [optional] **applicationName** | **string** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] **applicationVersion** | **string** | Version of the CyberSource application or integration used for a transaction. | [optional] diff --git a/docs/Model/Ptsv2paymentsConsumerAuthenticationInformation.md b/docs/Model/Ptsv2paymentsConsumerAuthenticationInformation.md index c0551de21..842d8e0d0 100644 --- a/docs/Model/Ptsv2paymentsConsumerAuthenticationInformation.md +++ b/docs/Model/Ptsv2paymentsConsumerAuthenticationInformation.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes **cavv** | **string** | Cardholder authentication verification value (CAVV). | [optional] **transactionFlowIndicator** | **string** | This field details out the type of transaction. Below are the possible values. 08:GC- Guest Checkout. | [optional] **cavvAlgorithm** | **string** | Algorithm used to generate the CAVV for Visa Secure or the UCAF authentication data for Mastercard Identity Check. | [optional] -**eciRaw** | **string** | Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**paresStatus** | **string** | Payer authentication response status. For details, see `pares_status` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**veresEnrolled** | **string** | Verification response enrollment status. For details, see `veres_enrolled` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**xid** | **string** | Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**ucafCollectionIndicator** | **string** | Universal cardholder authentication field (UCAF) collection indicator. For details, see `ucaf_collection_indicator` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator | [optional] -**ucafAuthenticationData** | **string** | Universal cardholder authentication field (UCAF) data. For details, see `ucaf_authentication_data` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**eciRaw** | **string** | Raw electronic commerce indicator (ECI). | [optional] +**paresStatus** | **string** | Payer authentication response status. | [optional] +**veresEnrolled** | **string** | Verification response enrollment status. | [optional] +**xid** | **string** | Transaction identifier. | [optional] +**ucafCollectionIndicator** | **string** | Universal cardholder authentication field (UCAF) collection indicator. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator | [optional] +**ucafAuthenticationData** | **string** | Universal cardholder authentication field (UCAF) data. | [optional] **strongAuthentication** | [**\CyberSource\Model\Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication**](Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication.md) | | [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] **paSpecificationVersion** | **string** | This field contains 3DS version that was used for Secured Consumer Authentication (SCA). For example 3DS secure version 1.0.2 or 2.0.0 is used for Secured Consumer Authentication. 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: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.0 (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.0)) For Cybersource connection through Visanet, below are additional values to be supported. - `2.1.0` (EMV 3D Secure Version 2.1) - `2.2.0` (EMV 3D Secure Version 2.2) - `2.3.0` (EMV 3D Secure Version 2.3) - `2.4.0` (EMV 3D Secure Version 2.4) - `2.5.0` (EMV 3D Secure Version 2.5) - `2.6.0` (EMV 3D Secure Version 2.6) - `2.7.0` (EMV 3D Secure Version 2.7) - `2.8.0` (EMV 3D Secure Version 2.8) - `2.9.0` (EMV 3D Secure Version 2.9) | [optional] @@ -25,7 +25,7 @@ Name | Type | Description | Notes **authenticationDate** | **string** | The date/time of the authentication at the 3DS servers. RISK update authorization service in auth request payload with value returned in `consumerAuthenticationInformation.alternateAuthenticationData` if merchant calls via CYBS or field can be provided by merchant in authorization request if calling an external 3DS provider. This field is supported for Cartes Bancaires Fast'R transactions on Credit Mutuel-CIC. Format: YYYYMMDDHHMMSS | [optional] **authenticationTransactionId** | **string** | Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.For Rupay,this is passed only in Re-Send OTP usecase. **Note**: Required for Standard integration, Rupay Seamless server to server integration for enroll service. Required for Hybrid integration for validate service. | [optional] **challengeCancelCode** | **string** | An indicator as to why the transaction was canceled. Possible Values: - `01`: Cardholder selected Cancel. - `02`: Reserved for future EMVCo use (values invalid until defined by EMVCo). - `03`: Transaction Timed Out—Decoupled Authentication - `04`: Transaction timed out at ACS—other timeouts - `05`: Transaction Timed out at ACS - First CReq not received by ACS - `06`: Transaction Error - `07`: Unknown - `08`: Transaction Timed Out at SDK | [optional] -**challengeCode** | **string** | Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html) | [optional] +**challengeCode** | **string** | Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. | [optional] **challengeStatus** | **string** | The `consumerAuthenticationInformation.challengeCode` indicates the authentication type/level, or challenge, that was presented to the cardholder at checkout by the merchant when calling the Carte Bancaire 3DS servers via CYBS RISK services. It conveys to the issuer the alternative authentication methods that the consumer used. | [optional] **customerCardAlias** | **string** | An alias that uniquely identifies the customer's account and credit card on file. Note This field is required if Tokenization is enabled in the merchant profile settings. | [optional] **decoupledAuthenticationIndicator** | **string** | Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use. Possible Values: Y - Decoupled Authentication is supported and preferred if challenge is necessary N - Do not use Decoupled Authentication **Default Value**: N | [optional] diff --git a/docs/Model/Ptsv2paymentsMerchantDefinedInformation.md b/docs/Model/Ptsv2paymentsMerchantDefinedInformation.md index baaa95c0f..448c0d92a 100644 --- a/docs/Model/Ptsv2paymentsMerchantDefinedInformation.md +++ b/docs/Model/Ptsv2paymentsMerchantDefinedInformation.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**key** | **string** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**value** | **string** | The value you assign for your merchant-defined data field. For details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 | [optional] +**key** | **string** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. | [optional] +**value** | **string** | The value you assign for your merchant-defined data field. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsOrderInformationAmountDetails.md b/docs/Model/Ptsv2paymentsOrderInformationAmountDetails.md index 25d09035d..d38d6d239 100644 --- a/docs/Model/Ptsv2paymentsOrderInformationAmountDetails.md +++ b/docs/Model/Ptsv2paymentsOrderInformationAmountDetails.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **giftWrapAmount** | **string** | Amount being charged as gift wrap fee. | [optional] -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] **subTotalAmount** | **string** | Subtotal amount of all the items.This amount (which is the value of all items in the cart, not including the additional amounts such as tax, shipping, etc.) cannot change after a sessions request. When there is a change to any of the additional amounts, this field should be resent in the order request. When the sub total amount changes, you must initiate a new transaction starting with a sessions request. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. This value can not be changed after a sessions request. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **discountAmount** | **string** | Total discount amount applied to the order. | [optional] **dutyAmount** | **string** | Total charges for any import or export duties included in the order. | [optional] **gratuityAmount** | **string** | Gratuity or tip amount for restaurants. Allowed only when industryDatatype=restaurant. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. Used by **Capture** Optional field. #### CyberSource through VisaNet Restaurant data is supported only on CyberSource through VisaNet when card is present. | [optional] @@ -15,10 +15,10 @@ Name | Type | Description | Notes **taxAppliedAfterDiscount** | **string** | Flag that indicates how the merchant manages discounts. Possible values: - **0**: no invoice level discount included - **1**: tax calculated on the postdiscount invoice total - **2**: tax calculated on the prediscount invoice total | [optional] **taxAppliedLevel** | **string** | Flag that indicates how you calculate tax. Possible values: - **0**: net prices with tax calculated at line item level - **1**: net prices with tax calculated at invoice level - **2**: gross prices with tax provided at line item level - **3**: gross prices with tax provided at invoice level - **4**: no tax applies on the invoice for the transaction | [optional] **taxTypeCode** | **string** | For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field. Possible values: - **056**: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space. | [optional] -**freightAmount** | **string** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**foreignAmount** | **string** | Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**freightAmount** | **string** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. | [optional] +**foreignAmount** | **string** | Set this field to the converted amount that was returned by the DCC provider. | [optional] **foreignCurrency** | **string** | Set this field to the converted amount that was returned by the DCC provider. | [optional] -**exchangeRate** | **string** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [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] +**exchangeRate** | **string** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. | [optional] **exchangeRateTimeStamp** | **string** | Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. | [optional] **surcharge** | [**\CyberSource\Model\Ptsv2paymentsOrderInformationAmountDetailsSurcharge**](Ptsv2paymentsOrderInformationAmountDetailsSurcharge.md) | | [optional] **settlementAmount** | **string** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] diff --git a/docs/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md b/docs/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md index 0687577eb..c57e47bef 100644 --- a/docs/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md +++ b/docs/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **string** | Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the `additional_amount_type0` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**code** | **string** | Additional amount type. This field is supported only for **American Express Direct**. | [optional] **amount** | **string** | Additional amount. This field is supported only for **American Express Direct**. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsOrderInformationBillTo.md b/docs/Model/Ptsv2paymentsOrderInformationBillTo.md index a7013df08..62613f7eb 100644 --- a/docs/Model/Ptsv2paymentsOrderInformationBillTo.md +++ b/docs/Model/Ptsv2paymentsOrderInformationBillTo.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **country** | **string** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **district** | **string** | Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**. | [optional] **buildingNumber** | **string** | Building number in the street address. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **emailDomain** | **string** | Email domain of the customer. The domain of the email address comprises all characters that follow the @ symbol, such as mail.example.com. For the Risk Update service, if the email address and the domain are sent in the request, the domain supersedes the email address. | [optional] **phoneNumber** | **string** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneType** | **string** | Customer's phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work | [optional] diff --git a/docs/Model/Ptsv2paymentsOrderInformationBillToCompany.md b/docs/Model/Ptsv2paymentsOrderInformationBillToCompany.md index 984c93d60..7d4cada90 100644 --- a/docs/Model/Ptsv2paymentsOrderInformationBillToCompany.md +++ b/docs/Model/Ptsv2paymentsOrderInformationBillToCompany.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **string** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**name** | **string** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] **address1** | **string** | First line in the street address of the company purchasing the product. | [optional] **address2** | **string** | Additional address information for the company purchasing the product. | [optional] **locality** | **string** | City in the address of the company purchasing the product. | [optional] diff --git a/docs/Model/Ptsv2paymentsPaymentInformationBank.md b/docs/Model/Ptsv2paymentsPaymentInformationBank.md index e621a2f5c..ceab0f320 100644 --- a/docs/Model/Ptsv2paymentsPaymentInformationBank.md +++ b/docs/Model/Ptsv2paymentsPaymentInformationBank.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account** | [**\CyberSource\Model\Ptsv2paymentsPaymentInformationBankAccount**](Ptsv2paymentsPaymentInformationBankAccount.md) | | [optional] -**routingNumber** | **string** | Bank routing number. This is also called the _transit number_. For details, see `ecp_rdfi` request 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] -**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**swiftCode** | **string** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**routingNumber** | **string** | Bank routing number. This is also called the _transit number_. | [optional] +**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] +**swiftCode** | **string** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] **code** | **string** | Bank code of the consumer's account | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsPaymentInformationBankAccount.md b/docs/Model/Ptsv2paymentsPaymentInformationBankAccount.md index df4c93d8a..acef09d3d 100644 --- a/docs/Model/Ptsv2paymentsPaymentInformationBankAccount.md +++ b/docs/Model/Ptsv2paymentsPaymentInformationBankAccount.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **string** | Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). | [optional] **number** | **string** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] -**encoderId** | **string** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**encoderId** | **string** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. | [optional] **checkNumber** | **string** | Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. | [optional] **checkImageReferenceNumber** | **string** | Image reference number associated with the check. You cannot include any special characters. | [optional] -**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsPaymentInformationCustomer.md b/docs/Model/Ptsv2paymentsPaymentInformationCustomer.md index 691a782bb..32130db5d 100644 --- a/docs/Model/Ptsv2paymentsPaymentInformationCustomer.md +++ b/docs/Model/Ptsv2paymentsPaymentInformationCustomer.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**customerId** | **string** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**customerId** | **string** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. | [optional] **id** | **string** | Unique identifier for the Customer token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsProcessingInformation.md b/docs/Model/Ptsv2paymentsProcessingInformation.md index 7eab861a2..6f0204720 100644 --- a/docs/Model/Ptsv2paymentsProcessingInformation.md +++ b/docs/Model/Ptsv2paymentsProcessingInformation.md @@ -9,17 +9,17 @@ Name | Type | Description | Notes **binSource** | **string** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional] **capture** | **bool** | Indicates whether to also include a capture in the submitted authorization request or not. Possible values: - `true`: Include a capture with an authorization request. - `false`: (default) Do not include a capture with an authorization request. #### Used by **Authorization and Capture** Optional field. | [optional] [default to false] **processorId** | **string** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field. | [optional] -**businessApplicationId** | **string** | Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional] -**commerceIndicator** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] -**commerceIndicatorLabel** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**businessApplicationId** | **string** | Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. | [optional] +**commerceIndicator** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**commerceIndicatorLabel** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` | [optional] **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 SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `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] **reconciliationId** | **string** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] **purchaseLevel** | **string** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **transactionTimeout** | **int** | The time-out limit in seconds for the transaction. The time-out limit starts when the customer is directed to the merchant URL that is included in the sale service response. The maximum value is 99999 (about 27 hours). When the transaction times out, the payment system changes the status to abandoned. | [optional] **intentsId** | **string** | Set to the value of the requestID field returned in the order service response. | [optional] **paymentId** | **string** | This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. | [optional] -**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **string** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **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] **authorizationOptions** | [**\CyberSource\Model\Ptsv2paymentsProcessingInformationAuthorizationOptions**](Ptsv2paymentsProcessingInformationAuthorizationOptions.md) | | [optional] diff --git a/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.md b/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.md index ae1346cb9..66c13af02 100644 --- a/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.md +++ b/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**authType** | **string** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### 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 more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] +**authType** | **string** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### 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. | [optional] **panReturnIndicator** | **string** | #### Visa Platform Connect The field contains the PAN translation indicator for American Express Contactless Transaction. Valid value is  1- Expresspay Translation, PAN request 2- Expresspay Translation, PAN and Expiry date request | [optional] -**verbalAuthCode** | **string** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] +**verbalAuthCode** | **string** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. | [optional] **verbalAuthTransactionId** | **string** | Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). | [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** | **bool** | 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] diff --git a/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md b/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md index 4f80b6813..3ba8c5118 100644 --- a/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md +++ b/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **string** | This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** | [optional] -**credentialStoredOnFile** | **bool** | Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **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] +**credentialStoredOnFile** | **bool** | Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] **storedCredentialUsed** | **bool** | Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file. Possible values: - **true** means the merchant-initiated transaction came from a card that was already stored on file. - **false** means the merchant-initiated transaction came from a card that was not stored on file. | [optional] **merchantInitiatedTransaction** | [**\CyberSource\Model\Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional] diff --git a/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md index 6fde74e2f..a71d06eb9 100644 --- a/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +++ b/docs/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reason** | **string** | Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**reason** | **string** | Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code | [optional] **previousTransactionId** | **string** | Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_ in the reply message for either the original merchant-initiated payment in the series or the previous merchant-initiated payment in the series. If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field: - For a **resubmission**, the transaction ID must be less than 14 days old. - For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] -**originalAuthorizedAmount** | **string** | Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**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] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.md b/docs/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.md index afe5b9c8b..7cae3e449 100644 --- a/docs/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.md +++ b/docs/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declineAvsFlags** | **string** | Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer's payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member's name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member's name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member's name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member's name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member's name, street address, and postal code do not match.| |O|Partial match: card member's name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member's name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member's name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| | [optional] -**secCode** | **string** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**secCode** | **string** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry | [optional] **terminalCity** | **string** | City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **terminalState** | **string** | State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **effectiveDate** | **string** | Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day. Format: `MMDDYYYY` Supported only for the CyberSource ACH Service. | [optional] -**partialPaymentId** | **string** | Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**partialPaymentId** | **string** | Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. | [optional] **customerMemo** | **string** | Payment related information. This information is included on the customer's statement. | [optional] -**paymentCategoryCode** | **string** | Flag that indicates whether to process the payment. Use with deferred payments. For details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. | [optional] -**settlementMethod** | **string** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] -**fraudScreeningLevel** | **string** | Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). | [optional] +**paymentCategoryCode** | **string** | Flag that indicates whether to process the payment. Use with deferred payments. Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. | [optional] +**settlementMethod** | **string** | Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) | [optional] +**fraudScreeningLevel** | **string** | Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification | [optional] **customerPresent** | **string** | Indicates whether a customer is physically present and whether the customer is enrolling in CyberSource Recurring Billing. Possible values: - `1`: Customer is present and not enrolling. - `2`: Customer is not present and not enrolling. - `3`: Customer is present and enrolling. - `4`: Customer is not present and enrolling. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsTokenInformation.md b/docs/Model/Ptsv2paymentsTokenInformation.md index 8cd718b32..7f68d7aab 100644 --- a/docs/Model/Ptsv2paymentsTokenInformation.md +++ b/docs/Model/Ptsv2paymentsTokenInformation.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **paymentInstrument** | [**\CyberSource\Model\Ptsv2paymentsTokenInformationPaymentInstrument**](Ptsv2paymentsTokenInformationPaymentInstrument.md) | | [optional] **shippingAddress** | [**\CyberSource\Model\Ptsv2paymentsTokenInformationShippingAddress**](Ptsv2paymentsTokenInformationShippingAddress.md) | | [optional] **networkTokenOption** | **string** | Indicates whether a payment network token associated with a TMS token should be used for authorization. This field can contain one of following values: - `ignore`: Use a tokenized card number for an authorization, even if the TMS token has an associated payment network token. - `prefer`: (Default) Use an associated payment network token for an authorization if the TMS token has one; otherwise, use the tokenized card number. | [optional] +**tokenProvisioningInformation** | [**\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md b/docs/Model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.md similarity index 94% rename from docs/Model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md rename to docs/Model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.md index 82a72b6f8..83bb13ee5 100644 --- a/docs/Model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md +++ b/docs/Model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.md @@ -1,4 +1,4 @@ -# TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation +# Ptsv2paymentsTokenInformationTokenProvisioningInformation ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Ptsv2paymentsidOrderInformationAmountDetails.md b/docs/Model/Ptsv2paymentsidOrderInformationAmountDetails.md index 50c259e5f..741e638f8 100644 --- a/docs/Model/Ptsv2paymentsidOrderInformationAmountDetails.md +++ b/docs/Model/Ptsv2paymentsidOrderInformationAmountDetails.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **additionalAmount** | **string** | Additional charges that have to be authorized against a lodging or auto-rental order. This value cannot be negative. You can include a decimal point (.), but no other special characters. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsidcapturesAggregatorInformation.md b/docs/Model/Ptsv2paymentsidcapturesAggregatorInformation.md index 499ab9a3f..09db2a391 100644 --- a/docs/Model/Ptsv2paymentsidcapturesAggregatorInformation.md +++ b/docs/Model/Ptsv2paymentsidcapturesAggregatorInformation.md @@ -3,8 +3,8 @@ ## Properties 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. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**name** | **string** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**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** | [**\CyberSource\Model\Ptsv2paymentsidcapturesAggregatorInformationSubMerchant**](Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsidcapturesBuyerInformation.md b/docs/Model/Ptsv2paymentsidcapturesBuyerInformation.md index cf123ef57..9900698cb 100644 --- a/docs/Model/Ptsv2paymentsidcapturesBuyerInformation.md +++ b/docs/Model/Ptsv2paymentsidcapturesBuyerInformation.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] +**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [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] **gender** | **string** | Customer's gender. Possible values are F (female), M (male),O (other). | [optional] **language** | **string** | language setting of the user | [optional] **personalIdentification** | [**\CyberSource\Model\Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification[]**](Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md) | | [optional] diff --git a/docs/Model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md b/docs/Model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md index 1f76bc795..859aea28c 100644 --- a/docs/Model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md +++ b/docs/Model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **string** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] +**id** | **string** | The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md b/docs/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md index d05081fb2..483096f2b 100644 --- a/docs/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md +++ b/docs/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **discountAmount** | **string** | Total discount amount applied to the order. | [optional] **dutyAmount** | **string** | Total charges for any import or export duties included in the order. | [optional] **gratuityAmount** | **string** | Gratuity or tip amount for restaurants. Allowed only when industryDatatype=restaurant. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. Used by **Capture** Optional field. #### CyberSource through VisaNet Restaurant data is supported only on CyberSource through VisaNet when card is present. | [optional] @@ -13,10 +13,10 @@ Name | Type | Description | Notes **taxAppliedAfterDiscount** | **string** | Flag that indicates how the merchant manages discounts. Possible values: - **0**: no invoice level discount included - **1**: tax calculated on the postdiscount invoice total - **2**: tax calculated on the prediscount invoice total | [optional] **taxAppliedLevel** | **string** | Flag that indicates how you calculate tax. Possible values: - **0**: net prices with tax calculated at line item level - **1**: net prices with tax calculated at invoice level - **2**: gross prices with tax provided at line item level - **3**: gross prices with tax provided at invoice level - **4**: no tax applies on the invoice for the transaction | [optional] **taxTypeCode** | **string** | For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field. Possible values: - **056**: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space. | [optional] -**freightAmount** | **string** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**foreignAmount** | **string** | Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**freightAmount** | **string** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. | [optional] +**foreignAmount** | **string** | Set this field to the converted amount that was returned by the DCC provider. | [optional] **foreignCurrency** | **string** | Set this field to the converted amount that was returned by the DCC provider. | [optional] -**exchangeRate** | **string** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [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] +**exchangeRate** | **string** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. | [optional] **exchangeRateTimeStamp** | **string** | Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. | [optional] **amexAdditionalAmounts** | [**\CyberSource\Model\Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts[]**](Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md) | | [optional] **taxDetails** | [**\CyberSource\Model\Ptsv2paymentsOrderInformationAmountDetailsTaxDetails[]**](Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] diff --git a/docs/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.md b/docs/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.md index ec6446288..2ab82b7a1 100644 --- a/docs/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.md +++ b/docs/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **postalCode** | **string** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional] **county** | **string** | U.S. county if available. | [optional] **country** | **string** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneNumber** | **string** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsidcapturesProcessingInformation.md b/docs/Model/Ptsv2paymentsidcapturesProcessingInformation.md index e7d17bc81..afe781388 100644 --- a/docs/Model/Ptsv2paymentsidcapturesProcessingInformation.md +++ b/docs/Model/Ptsv2paymentsidcapturesProcessingInformation.md @@ -5,8 +5,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 SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `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] **reconciliationId** | **string** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] +**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **string** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **purchaseLevel** | **string** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **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] diff --git a/docs/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md b/docs/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md index 794c3db79..3c1f0809c 100644 --- a/docs/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md +++ b/docs/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**authType** | **string** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### 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 more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] -**verbalAuthCode** | **string** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] +**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. | [optional] +**verbalAuthCode** | **string** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. | [optional] **verbalAuthTransactionId** | **string** | Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsidrefundsClientReferenceInformation.md b/docs/Model/Ptsv2paymentsidrefundsClientReferenceInformation.md index 57dca8350..15f379f74 100644 --- a/docs/Model/Ptsv2paymentsidrefundsClientReferenceInformation.md +++ b/docs/Model/Ptsv2paymentsidrefundsClientReferenceInformation.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **returnReconciliationId** | **string** | A new ID which is created for refund | [optional] **pausedRequestId** | **string** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional] **transactionId** | **string** | Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. | [optional] -**comments** | **string** | Comments | [optional] +**comments** | **string** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**\CyberSource\Model\Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [optional] **applicationName** | **string** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] **applicationVersion** | **string** | Version of the CyberSource application or integration used for a transaction. | [optional] diff --git a/docs/Model/Ptsv2paymentsidrefundsPaymentInformationBank.md b/docs/Model/Ptsv2paymentsidrefundsPaymentInformationBank.md index 42a001bf3..d1becde1a 100644 --- a/docs/Model/Ptsv2paymentsidrefundsPaymentInformationBank.md +++ b/docs/Model/Ptsv2paymentsidrefundsPaymentInformationBank.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account** | [**\CyberSource\Model\Ptsv2paymentsidrefundsPaymentInformationBankAccount**](Ptsv2paymentsidrefundsPaymentInformationBankAccount.md) | | [optional] -**routingNumber** | **string** | Bank routing number. This is also called the _transit number_. For details, see `ecp_rdfi` request 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] -**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**swiftCode** | **string** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**routingNumber** | **string** | Bank routing number. This is also called the _transit number_. | [optional] +**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] +**swiftCode** | **string** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md b/docs/Model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md index cae3d0139..4ea7d41b7 100644 --- a/docs/Model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md +++ b/docs/Model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **string** | Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). | [optional] **number** | **string** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] -**encoderId** | **string** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**encoderId** | **string** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. | [optional] **checkNumber** | **string** | Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. | [optional] **checkImageReferenceNumber** | **string** | Image reference number associated with the check. You cannot include any special characters. | [optional] diff --git a/docs/Model/Ptsv2paymentsidrefundsProcessingInformation.md b/docs/Model/Ptsv2paymentsidrefundsProcessingInformation.md index 8fa365e81..497447c29 100644 --- a/docs/Model/Ptsv2paymentsidrefundsProcessingInformation.md +++ b/docs/Model/Ptsv2paymentsidrefundsProcessingInformation.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes **actionList** | **string[]** | Array of actions (one or more) to be included in the payment to invoke bundled services along with payment status. Possible values are one or more of follows: - `AP_REFUND`: Use this when Alternative Payment Refund service is requested. | [optional] **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 SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `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] **reconciliationId** | **string** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] +**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **string** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **purchaseLevel** | **string** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **recurringOptions** | [**\CyberSource\Model\Ptsv2paymentsidrefundsProcessingInformationRecurringOptions**](Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.md) | | [optional] diff --git a/docs/Model/Ptsv2paymentsidreversalsClientReferenceInformation.md b/docs/Model/Ptsv2paymentsidreversalsClientReferenceInformation.md index bd8cf1f7d..6fac46d55 100644 --- a/docs/Model/Ptsv2paymentsidreversalsClientReferenceInformation.md +++ b/docs/Model/Ptsv2paymentsidreversalsClientReferenceInformation.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **string** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] **pausedRequestId** | **string** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional] -**comments** | **string** | Comments | [optional] +**comments** | **string** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**\CyberSource\Model\Ptsv2paymentsidreversalsClientReferenceInformationPartner**](Ptsv2paymentsidreversalsClientReferenceInformationPartner.md) | | [optional] **applicationName** | **string** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] **applicationVersion** | **string** | Version of the CyberSource application or integration used for a transaction. | [optional] diff --git a/docs/Model/Ptsv2paymentsidreversalsProcessingInformation.md b/docs/Model/Ptsv2paymentsidreversalsProcessingInformation.md index 44a2b872a..a548eb08d 100644 --- a/docs/Model/Ptsv2paymentsidreversalsProcessingInformation.md +++ b/docs/Model/Ptsv2paymentsidreversalsProcessingInformation.md @@ -5,8 +5,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 SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `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] **reconciliationId** | **string** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**linkId** | **string** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] +**reportGroup** | **string** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visaCheckoutId** | **string** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **issuer** | [**\CyberSource\Model\Ptsv2paymentsIssuerInformation**](Ptsv2paymentsIssuerInformation.md) | | [optional] **actionList** | **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] diff --git a/docs/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md b/docs/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md index ae9c4793a..09a7ba44e 100644 --- a/docs/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md +++ b/docs/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2payoutsOrderInformationAmountDetails.md b/docs/Model/Ptsv2payoutsOrderInformationAmountDetails.md index 2659f4c3f..a3090b4fb 100644 --- a/docs/Model/Ptsv2payoutsOrderInformationAmountDetails.md +++ b/docs/Model/Ptsv2payoutsOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **surcharge** | [**\CyberSource\Model\Ptsv2payoutsOrderInformationAmountDetailsSurcharge**](Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2payoutsRecipientInformation.md b/docs/Model/Ptsv2payoutsRecipientInformation.md index 5a739a139..bedffd064 100644 --- a/docs/Model/Ptsv2payoutsRecipientInformation.md +++ b/docs/Model/Ptsv2payoutsRecipientInformation.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **firstName** | **string** | First name of recipient. characters. * CTV (14) * Paymentech (30) | [optional] -**middleInitial** | **string** | Middle Initial of recipient. Required only for FDCCompass. | [optional] **middleName** | **string** | Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] **lastName** | **string** | Last name of recipient. characters. * CTV (14) * Paymentech (30) | [optional] **address1** | **string** | Recipient address information. Required only for FDCCompass. | [optional] @@ -13,7 +12,6 @@ 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] -**dateOfBirth** | **string** | Recipient date of birth in YYYYMMDD format. Required only for FDCCompass. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md b/docs/Model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md index 760757f9d..e2cb498da 100644 --- a/docs/Model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md +++ b/docs/Model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**customerId** | **string** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**customerId** | **string** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PushFunds201ResponseOrderInformationAmountDetails.md b/docs/Model/PushFunds201ResponseOrderInformationAmountDetails.md index f45f4174e..42a7a1677 100644 --- a/docs/Model/PushFunds201ResponseOrderInformationAmountDetails.md +++ b/docs/Model/PushFunds201ResponseOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. Note For Visa Platform Conenct, FDC Compass, and Chase Paymentech processors, the maximum length for this field is 12 numbers. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.994 Chase Paymentech: .01-9999999999.99 | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. | [optional] **currency** | **string** | Currency used for the order. Use the three-character ISO Standard Currency Codes | **settlementAmount** | **string** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **string** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] diff --git a/docs/Model/PushFunds201ResponseProcessorInformation.md b/docs/Model/PushFunds201ResponseProcessorInformation.md index efee8fe93..0b9f62498 100644 --- a/docs/Model/PushFunds201ResponseProcessorInformation.md +++ b/docs/Model/PushFunds201ResponseProcessorInformation.md @@ -5,10 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transactionId** | **int** | Network transaction identifier (TID). This value can be used to identify a specific transaction when you are discussing the transaction with your processor. | [optional] **responseCode** | **string** | Transaction status from the processor. | [optional] -**approvalCode** | **string** | Issuer-generated approval code for the transaction. | [optional] -**systemTraceAuditNumber** | **string** | System audit number. Returned by authorization and incremental authorization services. Visa Platform Connect System trace number that must be printed on the customer's receipt. | [optional] -**responseCodeSource** | **string** | Used by Visa only and contains the response source/reason code that identifies the source of the response decision. | [optional] -**retrievalReferenceNumber** | **string** | Unique reference number returned by the processor that identifies the transaction at the network. Supported by Mastercard Send | [optional] +**systemTraceAuditNumber** | **string** | System audit number. Returned by authorization and incremental authorization services. | [optional] +**retrievalReferenceNumber** | **string** | Unique reference number returned by the processor that identifies the transaction at the network. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PushFunds400Response.md b/docs/Model/PushFunds400Response.md index e9934fe1e..a28caf86e 100644 --- a/docs/Model/PushFunds400Response.md +++ b/docs/Model/PushFunds400Response.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **submitTimeUtc** | **string** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | **string** | Possible values: - INVALID_REQUEST | [optional] **reason** | **string** | The reason of the status. Possible values: - INVALID_DATA - MISSING_FIELD - INVALID_MERCHANT_CONFIGURATION - INVALID_REQUEST - INVALID_PAYMENT_ID | [optional] -**message** | **string** | The detail message related to the status and reason listed above. Possible values: - Declined - One or more fields in the request contains invalid data - Declined - The request is missing one or more fields - Declined - There is a problem with your CyberSource merchant configuration. | [optional] +**message** | **string** | The detail message related to the status and reason listed above. Possible values: - One or more fields in the request contains invalid data. - The request is missing one or more required fields. - Declined - There is a problem with your CyberSource merchant configuration. | [optional] **details** | [**\CyberSource\Model\PushFunds400ResponseDetails[]**](PushFunds400ResponseDetails.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/PushFundsRequest.md b/docs/Model/PushFundsRequest.md index c4a3eb120..f1aaf741b 100644 --- a/docs/Model/PushFundsRequest.md +++ b/docs/Model/PushFundsRequest.md @@ -6,13 +6,8 @@ Name | Type | Description | Notes **clientReferenceInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferClientReferenceInformation**](Ptsv1pushfundstransferClientReferenceInformation.md) | | [optional] **orderInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferOrderInformation**](Ptsv1pushfundstransferOrderInformation.md) | | **processingInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferProcessingInformation**](Ptsv1pushfundstransferProcessingInformation.md) | | -**processingOptions** | [**\CyberSource\Model\Ptsv1pushfundstransferProcessingOptions**](Ptsv1pushfundstransferProcessingOptions.md) | | [optional] **recipientInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferRecipientInformation**](Ptsv1pushfundstransferRecipientInformation.md) | | [optional] -**senderInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferSenderInformation**](Ptsv1pushfundstransferSenderInformation.md) | | -**aggregatorInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferAggregatorInformation**](Ptsv1pushfundstransferAggregatorInformation.md) | | [optional] -**merchantDefinedInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferMerchantDefinedInformation**](Ptsv1pushfundstransferMerchantDefinedInformation.md) | | [optional] -**merchantInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferMerchantInformation**](Ptsv1pushfundstransferMerchantInformation.md) | | [optional] -**pointOfServiceInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferPointOfServiceInformation**](Ptsv1pushfundstransferPointOfServiceInformation.md) | | [optional] +**senderInformation** | [**\CyberSource\Model\Ptsv1pushfundstransferSenderInformation**](Ptsv1pushfundstransferSenderInformation.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Rbsv1plansOrderInformationAmountDetails.md b/docs/Model/Rbsv1plansOrderInformationAmountDetails.md index 4427c61b2..27b158c8f 100644 --- a/docs/Model/Rbsv1plansOrderInformationAmountDetails.md +++ b/docs/Model/Rbsv1plansOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | **billingAmount** | **string** | Billing amount for the billing period. | **setupFee** | **string** | Subscription setup fee | [optional] diff --git a/docs/Model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md b/docs/Model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md index 1e18e25f3..f1a69c442 100644 --- a/docs/Model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md +++ b/docs/Model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**addressType** | **string** | Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. For possible values, see the description for the `dav_address_type` reply field in [CyberSource Verification Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/) #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown. | [optional] +**addressType** | **string** | Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown. | [optional] **barCode** | [**\CyberSource\Model\RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md) | | [optional] **applicableRegion** | **string** | Value can be - Canada - US - International The values of errorCode and statusCode mean different things depending on the applicable region. Refer to the guide for more info. | [optional] **errorCode** | **string** | Four-character error code returned for Canadian, US and international addresses. For possible values, see Verification Services guide. The meaning of the errorCode depends on value of applicableRegion. | [optional] diff --git a/docs/Model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md b/docs/Model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md index 8d52d0de1..a705181ec 100644 --- a/docs/Model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md +++ b/docs/Model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **acsRenderingType** | **string** | Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. | [optional] **acsTransactionId** | **string** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional] **acsUrl** | **string** | URL for the card-issuing bank's authentication form that you receive when the card is enrolled. The value can be very large. | [optional] -**authenticationPath** | **string** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional] +**authenticationPath** | **string** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. | [optional] **authorizationPayload** | **string** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional] **authenticationType** | **string** | Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band) 04 - Decoupled 20 - OTP hosted at merchant end. (Rupay S2S flow) **NOTE**: EMV 3-D Secure version 2.1.0 supports values 01-03. Version 2.2.0 supports values 01-04. Decoupled authentication is not supported at this time. | [optional] **authenticationTransactionId** | **string** | Payer authentication transaction identifier is used to link the check enrollment and validate authentication messages. For Rupay, this field should be passed as request only for Resend OTP use case. | [optional] @@ -30,7 +30,7 @@ Name | Type | Description | Notes **networkScore** | **string** | The global score calculated by the CB scoring platform and returned to merchants. | [optional] **pareq** | **string** | Payer authentication request (PAReq) message that you need to forward to the ACS. The value can be very large. The value is in base64. | [optional] **paresStatus** | **string** | Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - `A`: Proof of authentication attempt was generated. - `N`: Customer failed or canceled authentication. Transaction denied. - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated. | [optional] -**proofXml** | **string** | Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. | [optional] +**proofXml** | **string** | Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. | [optional] **proxyPan** | **string** | Encrypted version of the card number used in the payer authentication request message. | [optional] **sdkTransactionId** | **string** | SDK unique transaction identifier that is generated on each new transaction. | [optional] **signedParesStatusReason** | **string** | Provides additional information as to why the PAResStatus has a specific value. | [optional] @@ -39,7 +39,7 @@ Name | Type | Description | Notes **threeDSServerTransactionId** | **string** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] **ucafAuthenticationData** | **string** | AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request. | [optional] **ucafCollectionIndicator** | **string** | For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - `0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication. | [optional] -**veresEnrolled** | **string** | Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional] +**veresEnrolled** | **string** | Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. | [optional] **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] diff --git a/docs/Model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md b/docs/Model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md index 655b37d8f..b87ee9b16 100644 --- a/docs/Model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md +++ b/docs/Model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/RiskV1DecisionsPost201ResponsePaymentInformation.md b/docs/Model/RiskV1DecisionsPost201ResponsePaymentInformation.md index 0e5243ed4..8c6f05fe5 100644 --- a/docs/Model/RiskV1DecisionsPost201ResponsePaymentInformation.md +++ b/docs/Model/RiskV1DecisionsPost201ResponsePaymentInformation.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**binCountry** | **string** | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**accountType** | **string** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**issuer** | **string** | Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**scheme** | **string** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**bin** | **string** | Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**binCountry** | **string** | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. | [optional] +**accountType** | **string** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. | [optional] +**issuer** | **string** | Name of the bank or entity that issued the card account. | [optional] +**scheme** | **string** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. | [optional] +**bin** | **string** | Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1authenticationresultsOrderInformationAmountDetails.md b/docs/Model/Riskv1authenticationresultsOrderInformationAmountDetails.md index b9362df8c..a1eb67a2a 100644 --- a/docs/Model/Riskv1authenticationresultsOrderInformationAmountDetails.md +++ b/docs/Model/Riskv1authenticationresultsOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1authenticationsBuyerInformation.md b/docs/Model/Riskv1authenticationsBuyerInformation.md index be1b5f0d6..e25e68cbc 100644 --- a/docs/Model/Riskv1authenticationsBuyerInformation.md +++ b/docs/Model/Riskv1authenticationsBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] **personalIdentification** | [**\CyberSource\Model\Ptsv2paymentsBuyerInformationPersonalIdentification[]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | This array contains detailed information about the buyer's form of persoanl identification. | [optional] **mobilePhone** | **int** | Cardholder's mobile phone number. **Important** Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. | **workPhone** | **int** | Cardholder's work phone number. | [optional] diff --git a/docs/Model/Riskv1authenticationsOrderInformationAmountDetails.md b/docs/Model/Riskv1authenticationsOrderInformationAmountDetails.md index 4474fc985..e368c8be4 100644 --- a/docs/Model/Riskv1authenticationsOrderInformationAmountDetails.md +++ b/docs/Model/Riskv1authenticationsOrderInformationAmountDetails.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1authenticationsOrderInformationBillTo.md b/docs/Model/Riskv1authenticationsOrderInformationBillTo.md index af550d742..e974395b0 100644 --- a/docs/Model/Riskv1authenticationsOrderInformationBillTo.md +++ b/docs/Model/Riskv1authenticationsOrderInformationBillTo.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **firstName** | **string** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | **lastName** | **string** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | **phoneNumber** | **string** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | **postalCode** | **string** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1decisionsBuyerInformation.md b/docs/Model/Riskv1decisionsBuyerInformation.md index e7c1a2d86..91245c067 100644 --- a/docs/Model/Riskv1decisionsBuyerInformation.md +++ b/docs/Model/Riskv1decisionsBuyerInformation.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] **username** | **string** | Specifies the customer account user name. | [optional] -**hashedPassword** | **string** | The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**dateOfBirth** | **string** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**hashedPassword** | **string** | The merchant's password that CyberSource hashes and stores as a hashed password. | [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] **personalIdentification** | [**\CyberSource\Model\Ptsv2paymentsBuyerInformationPersonalIdentification[]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1decisionsConsumerAuthenticationInformation.md b/docs/Model/Riskv1decisionsConsumerAuthenticationInformation.md index 0ece116d1..3f65e741c 100644 --- a/docs/Model/Riskv1decisionsConsumerAuthenticationInformation.md +++ b/docs/Model/Riskv1decisionsConsumerAuthenticationInformation.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **authenticationTransactionId** | **string** | Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.For Rupay,this is passed only in Re-Send OTP usecase. **Note**: Required for Standard integration, Rupay Seamless server to server integration for enroll service. Required for Hybrid integration for validate service. | [optional] **transactionFlowIndicator** | **int** | This field is only applicable to Rupay and is optional. Merchant will have to pass a valid value from 01 through 07 which indicates the transaction flow. Below are the possible values. 01:NW- Transaction performed at domestic merchant. 02:TW- Transaction performed at domestic merchant along with Token provisioning. 03:IT- Transaction performed at International merchant. 04:AT- Authentication Transaction Only. 05:AW- Authentication transaction for provisioning. 06:DI- Domestic InApp Transaction. 07:II- International InApp transaction. 08:GC- Guest Checkout 09:ST- SI Authentication Transaction only 10:SW- SI Authorization along with token provisioning | [optional] **challengeCancelCode** | **string** | An indicator as to why the transaction was canceled. Possible Values: - `01`: Cardholder selected Cancel. - `02`: Reserved for future EMVCo use (values invalid until defined by EMVCo). - `03`: Transaction Timed Out—Decoupled Authentication - `04`: Transaction timed out at ACS—other timeouts - `05`: Transaction Timed out at ACS - First CReq not received by ACS - `06`: Transaction Error - `07`: Unknown - `08`: Transaction Timed Out at SDK | [optional] -**challengeCode** | **string** | Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html) | [optional] +**challengeCode** | **string** | Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. | [optional] **challengeStatus** | **string** | The `consumerAuthenticationInformation.challengeCode` indicates the authentication type/level, or challenge, that was presented to the cardholder at checkout by the merchant when calling the Carte Bancaire 3DS servers via CYBS RISK services. It conveys to the issuer the alternative authentication methods that the consumer used. | [optional] **customerCardAlias** | **string** | An alias that uniquely identifies the customer's account and credit card on file. Note This field is required if Tokenization is enabled in the merchant profile settings. | [optional] **decoupledAuthenticationIndicator** | **string** | Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use. Possible Values: Y - Decoupled Authentication is supported and preferred if challenge is necessary N - Do not use Decoupled Authentication **Default Value**: N | [optional] diff --git a/docs/Model/Riskv1decisionsOrderInformationAmountDetails.md b/docs/Model/Riskv1decisionsOrderInformationAmountDetails.md index c2f4f540e..53866765c 100644 --- a/docs/Model/Riskv1decisionsOrderInformationAmountDetails.md +++ b/docs/Model/Riskv1decisionsOrderInformationAmountDetails.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | **totalAmount** | **string** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1decisionsOrderInformationBillTo.md b/docs/Model/Riskv1decisionsOrderInformationBillTo.md index 1a41f095d..0591baffe 100644 --- a/docs/Model/Riskv1decisionsOrderInformationBillTo.md +++ b/docs/Model/Riskv1decisionsOrderInformationBillTo.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **firstName** | **string** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **lastName** | **string** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneNumber** | **string** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **postalCode** | **string** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1decisionsProcessorInformationCardVerification.md b/docs/Model/Riskv1decisionsProcessorInformationCardVerification.md index 19b42d98b..6ac16ae68 100644 --- a/docs/Model/Riskv1decisionsProcessorInformationCardVerification.md +++ b/docs/Model/Riskv1decisionsProcessorInformationCardVerification.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultCode** | **string** | CVN result code. For details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**resultCode** | **string** | CVN result code. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md b/docs/Model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md index 8997c2fce..a93540396 100644 --- a/docs/Model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md +++ b/docs/Model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **company** | [**\CyberSource\Model\Riskv1exportcomplianceinquiriesOrderInformationBillToCompany**](Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md) | | [optional] **firstName** | **string** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **lastName** | **string** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Riskv1liststypeentriesOrderInformationBillTo.md b/docs/Model/Riskv1liststypeentriesOrderInformationBillTo.md index 03420523f..3a08f2f64 100644 --- a/docs/Model/Riskv1liststypeentriesOrderInformationBillTo.md +++ b/docs/Model/Riskv1liststypeentriesOrderInformationBillTo.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **firstName** | **string** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **lastName** | **string** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneNumber** | **string** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **emailDomain** | **string** | Email domain of the customer. The domain of the email address comprises all characters that follow the @ symbol, such as mail.example.com. For the Risk Update service, if the email address and the domain are sent in the request, the domain supersedes the email address. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/TmsEmbeddedInstrumentIdentifier.md b/docs/Model/TmsEmbeddedInstrumentIdentifier.md index f528ce3a6..d90158f75 100644 --- a/docs/Model/TmsEmbeddedInstrumentIdentifier.md +++ b/docs/Model/TmsEmbeddedInstrumentIdentifier.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **string** | The Id of the Instrument Identifier Token. | [optional] **object** | **string** | The type. Possible Values: - instrumentIdentifier | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] -**type** | **string** | The type of Instrument Identifier. Possible Values: - enrollable card | [optional] -**tokenProvisioningInformation** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation**](TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.md) | | [optional] +**type** | **string** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**tokenProvisioningInformation** | [**\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] **card** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] **bankAccount** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] **tokenizedCard** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenizedCard**](TmsEmbeddedInstrumentIdentifierTokenizedCard.md) | | [optional] diff --git a/docs/Model/TmsEmbeddedInstrumentIdentifierTokenizedCard.md b/docs/Model/TmsEmbeddedInstrumentIdentifierTokenizedCard.md index f42fa4edb..727a50e3c 100644 --- a/docs/Model/TmsEmbeddedInstrumentIdentifierTokenizedCard.md +++ b/docs/Model/TmsEmbeddedInstrumentIdentifierTokenizedCard.md @@ -4,6 +4,7 @@ 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] diff --git a/docs/Model/TssV2TransactionsGet200ResponseBuyerInformation.md b/docs/Model/TssV2TransactionsGet200ResponseBuyerInformation.md index 4a10ebd65..ad9cdf3d8 100644 --- a/docs/Model/TssV2TransactionsGet200ResponseBuyerInformation.md +++ b/docs/Model/TssV2TransactionsGet200ResponseBuyerInformation.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**hashedPassword** | **string** | The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] +**hashedPassword** | **string** | The merchant's password that CyberSource hashes and stores as a hashed password. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md b/docs/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md index 3e79802f5..c62efb19d 100644 --- a/docs/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md +++ b/docs/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**eciRaw** | **string** | Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**eciRaw** | **string** | Raw electronic commerce indicator (ECI). | [optional] **cavv** | **string** | Cardholder authentication verification value (CAVV). | [optional] -**xid** | **string** | Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**xid** | **string** | Transaction identifier. | [optional] **transactionId** | **string** | Payer auth Transaction identifier. | [optional] **strongAuthentication** | [**\CyberSource\Model\TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication**](TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md) | | [optional] diff --git a/docs/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md b/docs/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md index 59aa7ef53..ca8641f9c 100644 --- a/docs/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md +++ b/docs/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**totalAmount** | **string** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **taxAmount** | **string** | Total tax amount for all the items in the order. | [optional] -**authorizedAmount** | **string** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. | [optional] +**authorizedAmount** | **string** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. | [optional] **settlementAmount** | **string** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **settlementCurrency** | **string** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional] **surcharge** | [**\CyberSource\Model\Ptsv2payoutsOrderInformationAmountDetailsSurcharge**](Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md) | | [optional] diff --git a/docs/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.md b/docs/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.md index f38f1ea8f..ff1c9268e 100644 --- a/docs/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.md +++ b/docs/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **locality** | **string** | Payment card billing city. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **administrativeArea** | **string** | 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). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **postalCode** | **string** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional] -**company** | **string** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**company** | **string** | Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **country** | **string** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **title** | **string** | Title. | [optional] **phoneNumber** | **string** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] diff --git a/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.md b/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.md index c3819a635..b214fca0a 100644 --- a/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.md +++ b/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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] -**branchCode** | **string** | Code used to identify the branch of the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction. For all possible values, see the `branch_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**swiftCode** | **string** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**bankCode** | **string** | Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] +**routingNumber** | **string** | Bank routing number. This is also called the transit number. | [optional] +**branchCode** | **string** | Code used to identify the branch of the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction. | [optional] +**swiftCode** | **string** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] +**bankCode** | **string** | Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. | [optional] +**iban** | **string** | International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. | [optional] **account** | [**\CyberSource\Model\TssV2TransactionsGet200ResponsePaymentInformationBankAccount**](TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md) | | [optional] **mandate** | [**\CyberSource\Model\TssV2TransactionsGet200ResponsePaymentInformationBankMandate**](TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md) | | [optional] diff --git a/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md b/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md index 385de23e5..1f17daab1 100644 --- a/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md +++ b/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes **checkNumber** | **string** | Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. | [optional] **type** | **string** | Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). | [optional] **name** | **string** | Name used on the bank account. You can use this field only when scoring a direct debit transaction | [optional] -**checkDigit** | **string** | Code used to validate the customer's account number. Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction. For all possible values, see the `bank_check_digit` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional] -**encoderId** | **string** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**checkDigit** | **string** | Code used to validate the customer's account number. Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction. | [optional] +**encoderId** | **string** | Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md b/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md index f2b775554..2e13859b8 100644 --- a/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md +++ b/docs/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**customerId** | **string** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**customerId** | **string** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. | [optional] **id** | **string** | Unique identifier for the Customer token that was created as part of a bundled TOKEN_CREATE action. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/TssV2TransactionsGet200ResponseProcessingInformation.md b/docs/Model/TssV2TransactionsGet200ResponseProcessingInformation.md index a14b35262..2bc2df793 100644 --- a/docs/Model/TssV2TransactionsGet200ResponseProcessingInformation.md +++ b/docs/Model/TssV2TransactionsGet200ResponseProcessingInformation.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes **binSource** | **string** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional] **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] **paymentSolution** | **string** | Type of digital payment solution for the transaction. | [optional] -**commerceIndicator** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] -**commerceIndicatorLabel** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] -**businessApplicationId** | **string** | Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional] +**commerceIndicator** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**commerceIndicatorLabel** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` | [optional] +**businessApplicationId** | **string** | Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. | [optional] **authorizationOptions** | [**\CyberSource\Model\TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md) | | [optional] **bankTransferOptions** | [**\CyberSource\Model\TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions**](TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md) | | [optional] **captureOptions** | [**\CyberSource\Model\TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions**](TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md) | | [optional] diff --git a/docs/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md b/docs/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md index df6e25c98..cb4372ced 100644 --- a/docs/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md +++ b/docs/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**authType** | **string** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### 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 more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional] +**authType** | **string** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### 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. | [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] **cardVerificationIndicator** | **bool** | This API field will indicate whether a card verification check is being performed during the transaction Possible values: - `true` - `false` (default value) | [optional] diff --git a/docs/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md b/docs/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md index 63815ec9a..d0bdfcb20 100644 --- a/docs/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md +++ b/docs/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **string** | Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**email** | **string** | Mapped Electronic Verification response code for the customer's email address. | [optional] **emailRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's email address. | [optional] **name** | **string** | #### Visa Platform Connect Mapped Electronic Verification response code for the customer's name. Valid values : 'Y' Yes, the data Matches 'N' No Match 'O' Partial Match | [optional] **nameRaw** | **string** | #### Visa Platform Connect Raw Electronic Verification response code from the processor for the customer's name. Valid values : '01' Match '50' Partial Match '99' No Match | [optional] -**phoneNumber** | **string** | Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**phoneNumber** | **string** | Mapped Electronic Verification response code for the customer's phone number. | [optional] **phoneNumberRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's phone number. | [optional] -**street** | **string** | Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**street** | **string** | Mapped Electronic Verification response code for the customer's street address. | [optional] **streetRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's street address. | [optional] -**postalCode** | **string** | Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**postalCode** | **string** | Mapped Electronic Verification response code for the customer's postal code. | [optional] **postalCodeRaw** | **string** | Raw Electronic Verification response code from the processor for the customer's postal code. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md b/docs/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md index 63e6f2850..2a2e28af5 100644 --- a/docs/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md +++ b/docs/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **string** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md b/docs/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md index 0b5325b9e..726e88f81 100644 --- a/docs/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md +++ b/docs/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**xid** | **string** | Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**xid** | **string** | Transaction identifier. | [optional] **transactionId** | **string** | Payer auth Transaction identifier. | [optional] -**eciRaw** | **string** | Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**eciRaw** | **string** | Raw electronic commerce indicator (ECI). | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md b/docs/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md index ec6e34261..2e330f78c 100644 --- a/docs/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md +++ b/docs/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **firstName** | **string** | Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **lastName** | **string** | Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **address1** | **string** | Payment card billing street address as it appears on the credit card issuer's records. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] -**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] +**email** | **string** | Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **country** | **string** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] **phoneNumber** | **string** | Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional] diff --git a/docs/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md b/docs/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md index ee09fc4d3..4553753f1 100644 --- a/docs/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +++ b/docs/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md @@ -4,9 +4,9 @@ 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 SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `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] -**businessApplicationId** | **string** | Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional] -**commerceIndicator** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] -**commerceIndicatorLabel** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**businessApplicationId** | **string** | Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. | [optional] +**commerceIndicator** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] +**commerceIndicatorLabel** | **string** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/VasV2TaxVoid200ResponseVoidAmountDetails.md b/docs/Model/VasV2TaxVoid200ResponseVoidAmountDetails.md index 04188b755..583ac9a8d 100644 --- a/docs/Model/VasV2TaxVoid200ResponseVoidAmountDetails.md +++ b/docs/Model/VasV2TaxVoid200ResponseVoidAmountDetails.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **voidAmount** | **string** | Total amount of the void. #### PIN Debit Amount of the reversal. Returned by PIN debit reversal. | [optional] -**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] +**currency** | **string** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Vasv2taxBuyerInformation.md b/docs/Model/Vasv2taxBuyerInformation.md index e769d1bb1..befd11410 100644 --- a/docs/Model/Vasv2taxBuyerInformation.md +++ b/docs/Model/Vasv2taxBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**vatRegistrationNumber** | **string** | Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Vasv2taxClientReferenceInformation.md b/docs/Model/Vasv2taxClientReferenceInformation.md index 7b94e226e..00bf5829e 100644 --- a/docs/Model/Vasv2taxClientReferenceInformation.md +++ b/docs/Model/Vasv2taxClientReferenceInformation.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **string** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] **partner** | [**\CyberSource\Model\Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] -**comments** | **string** | Comments | [optional] +**comments** | **string** | Brief description of the order or any comment you wish to add to the order. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/Vasv2taxidClientReferenceInformation.md b/docs/Model/Vasv2taxidClientReferenceInformation.md index ee59dcc30..cd513da44 100644 --- a/docs/Model/Vasv2taxidClientReferenceInformation.md +++ b/docs/Model/Vasv2taxidClientReferenceInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **string** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] -**comments** | **string** | Comments | [optional] +**comments** | **string** | Brief description of the order or any comment you wish to add to the order. | [optional] **partner** | [**\CyberSource\Model\Vasv2taxidClientReferenceInformationPartner**](Vasv2taxidClientReferenceInformationPartner.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json index 884f78cd8..4b160e7dc 100644 --- a/generator/cybersource-rest-spec.json +++ b/generator/cybersource-rest-spec.json @@ -97,11 +97,11 @@ "description": "REST APIs for Risk Services" }, { - "name": "Pull_Funds", + "name": "Pull Funds", "description": "Cybersource Payouts Funds Transfer REST API for Account Funding Transaction (AFT)\n" }, { - "name": "Push_Funds", + "name": "Push Funds", "description": "A payout enables an originator to send funds on behalf of itself, merchants, or customers to credit card\naccounts using an Original Credit Transaction (OCT). An originator is a merchant, government entity, or\ncorporation with a merchant account from an acquiring bank.\n" }, { @@ -407,7 +407,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -485,17 +485,17 @@ }, "businessApplicationId": { "type": "string", - "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n" }, "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "commerceIndicatorLabel": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as `moto`\n" }, "paymentSolution": { "type": "string", @@ -510,7 +510,7 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "purchaseLevel": { "type": "string", @@ -535,7 +535,7 @@ "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -553,7 +553,7 @@ "authType": { "type": "string", "maxLength": 15, - "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization.\n" }, "panReturnIndicator": { "type": "string", @@ -563,7 +563,7 @@ "verbalAuthCode": { "type": "string", "maxLength": 7, - "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### PIN debit\nAuthorization code that is returned by the processor.\n\nReturned by PIN debit purchase.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### PIN debit\nAuthorization code that is returned by the processor.\n\nReturned by PIN debit purchase.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n" }, "verbalAuthTransactionId": { "type": "string", @@ -613,7 +613,7 @@ }, "credentialStoredOnFile": { "type": "boolean", - "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions.\n\nValid values:\n- `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\nFor details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n" + "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions.\n\nValid values:\n- `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n" }, "storedCredentialUsed": { "type": "boolean", @@ -625,7 +625,7 @@ "reason": { "type": "string", "maxLength": 1, - "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n\n#### All Processors\nFor details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n" }, "previousTransactionId": { "type": "string", @@ -635,7 +635,7 @@ "originalAuthorizedAmount": { "type": "string", "maxLength": 61, - "description": "Amount of the original authorization.\n\nThis field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech.\n\nSee \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization\nUsing the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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" } } } @@ -736,7 +736,7 @@ "secCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" }, "terminalCity": { "type": "string", @@ -756,7 +756,7 @@ "partialPaymentId": { "type": "string", "maxLength": 25, - "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\nFor details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\n" }, "customerMemo": { "type": "string", @@ -766,17 +766,17 @@ "paymentCategoryCode": { "type": "string", "maxLength": 1, - "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments.\nFor details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n\nPossible values:\n- `0`: Standard debit with immediate payment (default).\n- `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request\nwith `paymentCategoryCode = 2` in the future.\n- `2`: For deferred payments, indicates notification to initiate payment.\n\n#### Chase Paymentech Solutions and TeleCheck\nUse for deferred and partial payments.\n\n#### CyberSource ACH Service\nNot used.\n\n#### RBS WorldPay Atlanta\nNot used.\n" + "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments.\n\nPossible values:\n- `0`: Standard debit with immediate payment (default).\n- `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request\nwith `paymentCategoryCode = 2` in the future.\n- `2`: For deferred payments, indicates notification to initiate payment.\n\n#### Chase Paymentech Solutions and TeleCheck\nUse for deferred and partial payments.\n\n#### CyberSource ACH Service\nNot used.\n\n#### RBS WorldPay Atlanta\nNot used.\n" }, "settlementMethod": { "type": "string", "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n" }, "fraudScreeningLevel": { "type": "string", "maxLength": 1, - "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n" }, "customerPresent": { "type": "string", @@ -1153,7 +1153,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -1226,7 +1226,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -1241,23 +1241,23 @@ "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" } } }, "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request 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" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "code": { "type": "string", @@ -1369,7 +1369,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "subTotalAmount": { "type": "string", @@ -1379,7 +1379,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -1424,12 +1424,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -1439,7 +1439,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -1478,7 +1478,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -1655,7 +1655,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -1747,7 +1747,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "emailDomain": { "type": "string", @@ -2290,17 +2290,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "companyTaxId": { "type": "string", @@ -2314,16 +2314,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -2335,7 +2335,7 @@ "hashedPassword": { "type": "string", "maxLength": 100, - "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n" }, "gender": { "type": "string", @@ -2729,12 +2729,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -2819,32 +2819,32 @@ "eciRaw": { "type": "string", "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI).\n\nFor details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Raw electronic commerce indicator (ECI).\n" }, "paresStatus": { "type": "string", "maxLength": 1, - "description": "Payer authentication response status.\n\nFor details, see `pares_status` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Payer authentication response status.\n" }, "veresEnrolled": { "type": "string", "maxLength": 1, - "description": "Verification response enrollment status.\n\nFor details, see `veres_enrolled` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Verification response enrollment status.\n" }, "xid": { "type": "string", "maxLength": 40, - "description": "Transaction identifier.\n\nFor details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Transaction identifier.\n" }, "ucafCollectionIndicator": { "type": "string", "maxLength": 1, - "description": "Universal cardholder authentication field (UCAF) collection indicator.\n\nFor details, see `ucaf_collection_indicator` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR7\n- Position: 5\n- Field: Mastercard Electronic Commerce Indicators\u2014UCAF Collection Indicator\n" + "description": "Universal cardholder authentication field (UCAF) collection indicator.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR7\n- Position: 5\n- Field: Mastercard Electronic Commerce Indicators\u2014UCAF Collection Indicator\n" }, "ucafAuthenticationData": { "type": "string", "maxLength": 32, - "description": "Universal cardholder authentication field (UCAF) data.\n\nFor details, see `ucaf_authentication_data` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Universal cardholder authentication field (UCAF) data.\n" }, "strongAuthentication": { "type": "object", @@ -2956,7 +2956,7 @@ }, "challengeCode": { "type": "string", - "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n\nFor details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html)\n" + "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n" }, "challengeStatus": { "type": "string", @@ -3317,12 +3317,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -4533,6 +4533,19 @@ "networkTokenOption": { "type": "string", "description": "Indicates whether a payment network token associated with a TMS token should be used for authorization. This field can contain one of following values:\n\n- `ignore`: Use a tokenized card number for an authorization, even if the TMS token has an associated payment network token.\n- `prefer`: (Default) Use an associated payment network token for an authorization if the TMS token has one; otherwise, use the tokenized card number.\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } } } }, @@ -5093,12 +5106,12 @@ "settlementMethod": { "type": "string", "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n" }, "fraudScreeningLevel": { "type": "string", "maxLength": 1, - "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n" } } }, @@ -5191,7 +5204,7 @@ "resultCode": { "type": "string", "maxLength": 1, - "description": "CVN result code.\n\nFor details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "CVN result code.\n" }, "resultCodeRaw": { "type": "string", @@ -5226,7 +5239,7 @@ "code": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's name.\n\nFor details, see `auth_ev_name` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's name.\n" }, "codeRaw": { "type": "string", @@ -5236,7 +5249,7 @@ "email": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's email address.\n\nFor details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's email address.\n" }, "emailRaw": { "type": "string", @@ -5246,7 +5259,7 @@ "phoneNumber": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's phone number.\n\nFor details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's phone number.\n" }, "phoneNumberRaw": { "type": "string", @@ -5256,7 +5269,7 @@ "postalCode": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's postal code.\n\nFor details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's postal code.\n" }, "postalCodeRaw": { "type": "string", @@ -5266,7 +5279,7 @@ "street": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's street address.\n\nFor details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's street address.\n" }, "streetRaw": { "type": "string", @@ -5321,12 +5334,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -5756,14 +5769,14 @@ "correctedAccountNumber": { "type": "string", "maxLength": 17, - "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Corrected account number from the ACH verification service.\n" } } }, "correctedRoutingNumber": { "type": "string", "maxLength": 9, - "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Corrected account number from the ACH verification service.\n" } } }, @@ -5772,7 +5785,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -5822,27 +5835,27 @@ "scheme": { "type": "string", "maxLength": 255, - "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n\nFor all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n" }, "bin": { "type": "string", "maxLength": 255, - "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n\nFor all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n" }, "accountType": { "type": "string", "maxLength": 255, - "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n\nFor all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n" }, "issuer": { "type": "string", "maxLength": 255, - "description": "Name of the bank or entity that issued the card account.\n\nFor all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Name of the bank or entity that issued the card account.\n" }, "binCountry": { "type": "string", "maxLength": 255, - "description": "Country (two-digit country code) associated with the BIN of the customer's card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n\nFor all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Country (two-digit country code) associated with the BIN of the customer's card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n" }, "eWallet": { "type": "object", @@ -5900,12 +5913,12 @@ "authorizedAmount": { "type": "string", "maxLength": 15, - "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API.\n" + "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "settlementAmount": { "type": "string", @@ -6354,17 +6367,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "personalIdentification": { "type": "array", @@ -6373,16 +6386,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -6779,7 +6792,7 @@ }, "authenticationPath": { "type": "string", - "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n\nFor details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\"\nin [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n" }, "authorizationPayload": { "type": "string", @@ -6936,7 +6949,7 @@ }, "proofXml": { "type": "string", - "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in\n[CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n- For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.\n- For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" + "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. \nFor cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" }, "proxyPan": { "type": "string", @@ -6976,7 +6989,7 @@ }, "veresEnrolled": { "type": "string", - "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n\nFor details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n" }, "whiteListStatusSource": { "type": "string", @@ -10110,7 +10123,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -10343,12 +10356,12 @@ "authorizedAmount": { "type": "string", "maxLength": 15, - "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API.\n" + "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "settlementAmount": { "type": "string", @@ -10578,7 +10591,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -10633,12 +10646,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -10664,12 +10677,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -10868,7 +10881,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -11168,7 +11181,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -11218,12 +11231,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -11249,12 +11262,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -11439,7 +11452,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -11679,7 +11692,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -11736,12 +11749,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -11774,12 +11787,12 @@ "authType": { "type": "string", "maxLength": 15, - "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization.\n" }, "verbalAuthCode": { "type": "string", "maxLength": 7, - "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### PIN debit\nAuthorization code that is returned by the processor.\n\nReturned by PIN debit purchase.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### PIN debit\nAuthorization code that is returned by the processor.\n\nReturned by PIN debit purchase.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n" }, "verbalAuthTransactionId": { "type": "string", @@ -11846,7 +11859,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -11896,12 +11909,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -11946,12 +11959,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -11961,7 +11974,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -11976,7 +11989,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -12073,7 +12086,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -12150,7 +12163,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "phoneNumber": { "type": "string", @@ -12510,17 +12523,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -12540,7 +12553,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -12691,12 +12704,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -12784,12 +12797,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -14251,7 +14264,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "processorTransactionFee": { "type": "string", @@ -14552,7 +14565,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -14616,12 +14629,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -14749,7 +14762,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -14766,16 +14779,16 @@ "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request 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" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" } } }, @@ -14872,7 +14885,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -14969,12 +14982,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -15019,12 +15032,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -15034,7 +15047,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -15049,7 +15062,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -15146,7 +15159,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -15223,7 +15236,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "phoneNumber": { "type": "string", @@ -15471,17 +15484,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -15501,7 +15514,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -15632,12 +15645,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -15720,12 +15733,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -16888,7 +16901,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -16926,12 +16939,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -16965,12 +16978,12 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -17205,7 +17218,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -17269,12 +17282,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -17402,7 +17415,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -17419,16 +17432,16 @@ "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request 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" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" } } }, @@ -17525,7 +17538,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -17622,12 +17635,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -17672,12 +17685,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -17687,7 +17700,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -17702,7 +17715,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -17799,7 +17812,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -17876,7 +17889,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "phoneNumber": { "type": "string", @@ -18124,17 +18137,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -18154,7 +18167,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -18285,12 +18298,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -18373,12 +18386,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -19541,7 +19554,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -19579,12 +19592,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -19618,12 +19631,12 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -19832,7 +19845,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -19879,7 +19892,7 @@ "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "processorId": { "type": "string", @@ -19899,12 +19912,12 @@ "linkId": { "type": "string", "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n" }, "reportGroup": { "type": "string", "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n" }, "visaCheckoutId": { "type": "string", @@ -19957,7 +19970,7 @@ "secCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" }, "terminalCity": { "type": "string", @@ -19977,12 +19990,12 @@ "partialPaymentId": { "type": "string", "maxLength": 25, - "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\nFor details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\n" }, "settlementMethod": { "type": "string", "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n" } } }, @@ -20132,7 +20145,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -20149,16 +20162,16 @@ "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request 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" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" } } }, @@ -20255,7 +20268,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -20352,12 +20365,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -20402,12 +20415,12 @@ "freightAmount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -20417,7 +20430,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -20432,7 +20445,7 @@ "code": { "type": "string", "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type0` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n" }, "amount": { "type": "string", @@ -20529,7 +20542,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "address1": { "type": "string", @@ -20606,7 +20619,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "phoneNumber": { "type": "string", @@ -20854,17 +20867,17 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -20884,7 +20897,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -21015,12 +21028,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: Payment Facilitator ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -21267,12 +21280,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -22534,7 +22547,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -22547,7 +22560,7 @@ "settlementMethod": { "type": "string", "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n" } } }, @@ -22591,12 +22604,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -22623,14 +22636,14 @@ "correctedAccountNumber": { "type": "string", "maxLength": 17, - "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Corrected account number from the ACH verification service.\n" } } }, "correctedRoutingNumber": { "type": "string", "maxLength": 9, - "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Corrected account number from the ACH verification service.\n" } } }, @@ -22639,7 +22652,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -22707,12 +22720,12 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "foreignAmount": { "type": "string", "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Set this field to the converted amount that was returned by the DCC provider.\n" }, "foreignCurrency": { "type": "string", @@ -23351,7 +23364,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -23433,12 +23446,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -23563,7 +23576,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -23816,7 +23829,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -23898,12 +23911,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -24028,7 +24041,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -24210,7 +24223,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -24292,12 +24305,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -24422,7 +24435,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -24604,7 +24617,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -24686,12 +24699,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -24816,7 +24829,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -25018,7 +25031,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -25095,12 +25108,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -25196,7 +25209,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -25322,7 +25335,7 @@ "/pts/v1/transaction-batches": { "get": { "summary": "Get a List of Batch Files", - "description": "Provide the search range", + "description": "Provide the date and time search range to get a list of Batch Files ready for settlement", "tags": [ "TransactionBatches" ], @@ -25626,7 +25639,7 @@ "/pts/v1/transaction-batches/{id}": { "get": { "summary": "Get Individual Batch File", - "description": "Provide the search range", + "description": "This API provides details like upload date, completion date, transaction count and accepted and rejected transaction count of the individual batch file using the batch id", "tags": [ "TransactionBatches" ], @@ -26222,7 +26235,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" } } }, @@ -26383,7 +26396,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" } } }, @@ -26457,7 +26470,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "verificationStatus": { "type": "string", @@ -26659,7 +26672,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -26706,7 +26719,7 @@ "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -26931,12 +26944,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -26986,7 +26999,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "firstName": { "type": "string", @@ -27169,7 +27182,7 @@ "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -27820,7 +27833,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -27867,7 +27880,7 @@ "name": { "type": "string", "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" }, "subMerchant": { "type": "object", @@ -28092,12 +28105,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -28147,7 +28160,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "firstName": { "type": "string", @@ -28325,7 +28338,7 @@ "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -29146,7 +29159,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -29304,12 +29317,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -29359,7 +29372,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "firstName": { "type": "string", @@ -30090,7 +30103,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", @@ -30156,12 +30169,12 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -30399,7 +30412,7 @@ "properties": { "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "account": { "type": "object", @@ -30412,7 +30425,7 @@ "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" } } } @@ -30580,12 +30593,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -30605,7 +30618,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -30740,7 +30753,7 @@ "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -30765,7 +30778,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -30969,12 +30982,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -31367,7 +31380,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } } @@ -31544,7 +31557,7 @@ "properties": { "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "account": { "type": "object", @@ -31557,7 +31570,7 @@ "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" } } } @@ -31725,12 +31738,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -31750,7 +31763,7 @@ "exchangeRate": { "type": "string", "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` request-level field description in the [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": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n" }, "exchangeRateTimeStamp": { "type": "string", @@ -31885,7 +31898,7 @@ "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "gender": { "type": "string", @@ -31910,7 +31923,7 @@ "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" } } } @@ -32114,12 +32127,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -32519,7 +32532,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } } @@ -33114,7 +33127,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -33180,6 +33193,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -34005,7 +34024,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -34071,6 +34090,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -35214,7 +35239,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -35280,6 +35305,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -36420,7 +36451,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -36486,6 +36517,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -37320,7 +37357,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -37386,6 +37423,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -41750,7 +41793,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -41816,6 +41859,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -42389,7 +42438,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -42455,6 +42504,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -43561,7 +43616,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -43627,6 +43682,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -44548,7 +44609,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -44614,6 +44675,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -45498,7 +45565,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -45564,6 +45631,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -46133,7 +46206,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -46199,6 +46272,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -47619,7 +47698,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -47685,6 +47764,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -48240,7 +48325,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -48306,6 +48391,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -49262,7 +49353,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -49328,6 +49419,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -50203,7 +50300,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -50269,6 +50366,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -50838,7 +50941,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -50904,6 +51007,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -51889,7 +51998,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -51955,6 +52064,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -52203,7 +52318,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -52269,6 +52384,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -52505,7 +52626,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -52571,6 +52692,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -53153,7 +53280,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -53219,6 +53346,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -53788,7 +53921,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -53854,6 +53987,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -54116,7 +54255,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -54182,6 +54321,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -55635,7 +55780,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -55701,6 +55846,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -56272,7 +56423,7 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n" + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" }, "tokenProvisioningInformation": { "type": "object", @@ -56338,6 +56489,12 @@ "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n", "example": "visa" }, + "source": { + "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" + }, "state": { "type": "string", "readOnly": true, @@ -57594,7 +57751,7 @@ "resultCode": { "type": "string", "maxLength": 1, - "description": "CVN result code.\n\nFor details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "CVN result code.\n" } } } @@ -57682,7 +57839,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -57711,7 +57868,7 @@ "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" }, "checkNumber": { "type": "string", @@ -57726,23 +57883,23 @@ "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" } } }, "routingNumber": { "type": "string", "maxLength": 9, - "description": "Bank routing number. This is also called the _transit number_.\n\nFor details, see `ecp_rdfi` request 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" + "description": "Bank routing number. This is also called the _transit number_.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "code": { "type": "string", @@ -57772,7 +57929,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "totalAmount": { "type": "string", @@ -58072,7 +58229,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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", @@ -58095,7 +58252,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "username": { "type": "string", @@ -58105,12 +58262,12 @@ "hashedPassword": { "type": "string", "maxLength": 100, - "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "personalIdentification": { "type": "array", @@ -58119,16 +58276,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -58623,7 +58780,7 @@ }, "challengeCode": { "type": "string", - "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n\nFor details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html)\n" + "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n" }, "challengeStatus": { "type": "string", @@ -59312,27 +59469,27 @@ "binCountry": { "type": "string", "maxLength": 255, - "description": "Country (two-digit country code) associated with the BIN of the customer's card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n\nFor all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Country (two-digit country code) associated with the BIN of the customer's card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n" }, "accountType": { "type": "string", "maxLength": 255, - "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n\nFor all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n" }, "issuer": { "type": "string", "maxLength": 255, - "description": "Name of the bank or entity that issued the card account.\n\nFor all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Name of the bank or entity that issued the card account.\n" }, "scheme": { "type": "string", "maxLength": 255, - "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n\nFor all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n" }, "bin": { "type": "string", "maxLength": 255, - "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n\nFor all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n" } } }, @@ -59375,7 +59532,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -59404,7 +59561,7 @@ }, "authenticationPath": { "type": "string", - "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n\nFor details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\"\nin [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n" }, "authorizationPayload": { "type": "string", @@ -59545,7 +59702,7 @@ }, "proofXml": { "type": "string", - "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in\n[CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n- For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.\n- For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" + "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. \nFor cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" }, "proxyPan": { "type": "string", @@ -59585,7 +59742,7 @@ }, "veresEnrolled": { "type": "string", - "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n\nFor details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n" }, "whiteListStatusSource": { "type": "string", @@ -61013,12 +61170,12 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } }, @@ -61322,7 +61479,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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", @@ -61456,7 +61613,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -61506,7 +61663,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "personalIdentification": { "description": "This array contains detailed information about the buyer's form of persoanl identification.", @@ -61516,16 +61673,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -61790,7 +61947,7 @@ }, "challengeCode": { "type": "string", - "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n\nFor details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html)\n" + "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05`: No challenge requested (transactional risk analysis is already performed)\n- `06`: No challenge requested (Data share only)\n- `07`: No challenge requested (strong consumer authentication is already performed)\n- `08`: No challenge requested (utilize whitelist exemption if no challenge required)\n- `09`: Challenge requested (whitelist prompt requested if challenge required)\n**Note** This field will default to `01` on merchant configuration and can be overridden by the merchant.\nEMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`.\n" }, "challengeStatus": { "type": "string", @@ -62195,7 +62352,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -62224,7 +62381,7 @@ }, "authenticationPath": { "type": "string", - "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n\nFor details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\"\nin [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer's authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n" }, "authorizationPayload": { "type": "string", @@ -62365,7 +62522,7 @@ }, "proofXml": { "type": "string", - "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in\n[CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n- For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.\n- For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" + "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. \nFor cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" }, "proxyPan": { "type": "string", @@ -62405,7 +62562,7 @@ }, "veresEnrolled": { "type": "string", - "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n\nFor details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n" + "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n" }, "whiteListStatusSource": { "type": "string", @@ -62930,12 +63087,12 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } } @@ -63031,7 +63188,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -63580,7 +63737,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "emailDomain": { "type": "string", @@ -63781,16 +63938,16 @@ "properties": { "type": { "type": "string", - "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" }, "id": { "type": "string", "maxLength": 26, - "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" }, "issuedBy": { "type": "string", - "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n" }, "verificationResults": { "type": "string", @@ -65293,7 +65450,7 @@ "addressType": { "type": "string", "maxLength": 255, - "description": "Contains the record type of the postal code with which the address was matched.\n\n#### U.S. Addresses\nDepending on the quantity and quality of the address information provided,\nthis field contains one or two characters:\n\n- One character: sufficient correct information was provided to result in accurate matching.\n- Two characters: standardization would provide a better address if more or better\ninput address information were available. The second character is D (default).\n\nBlank fields are unassigned. When an address cannot be standardized, how the input\ndata was parsed determines the address type. In this case, standardization may indicate a street, rural route,\nhighway contract, general delivery, or PO box. For possible values, see the description for the `dav_address_type` reply field in [CyberSource Verification Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\n#### All Other Countries\nThis field contains one of the following values:\n- P: Post.\n- S: Street.\n- x: Unknown.\n" + "description": "Contains the record type of the postal code with which the address was matched.\n\n#### U.S. Addresses\nDepending on the quantity and quality of the address information provided,\nthis field contains one or two characters:\n\n- One character: sufficient correct information was provided to result in accurate matching.\n- Two characters: standardization would provide a better address if more or better\ninput address information were available. The second character is D (default).\n\nBlank fields are unassigned. When an address cannot be standardized, how the input\ndata was parsed determines the address type. In this case, standardization may indicate a street, rural route,\nhighway contract, general delivery, or PO box. \n\n#### All Other Countries\nThis field contains one of the following values:\n- P: Post.\n- S: Street.\n- x: Unknown.\n" }, "barCode": { "type": "object", @@ -66016,7 +66173,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" } } }, @@ -66790,12 +66947,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "surcharge": { "type": "object", @@ -66934,11 +67091,6 @@ "maxLength": 35, "description": "First name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n" }, - "middleInitial": { - "type": "string", - "maxLength": 1, - "description": "Middle Initial of recipient. Required only for FDCCompass.\n" - }, "middleName": { "type": "string", "maxLength": 35, @@ -66967,6 +67119,7 @@ "country": { "type": "string", "maxLength": 2, + "minLength": 2, "description": "Recipient country code. Required only for FDCCompass." }, "postalCode": { @@ -66978,12 +67131,6 @@ "type": "string", "maxLength": 20, "description": "Recipient phone number. Required only for FDCCompass." - }, - "dateOfBirth": { - "type": "string", - "minLength": 8, - "maxLength": 8, - "description": "Recipient date of birth in YYYYMMDD format. Required only for FDCCompass." } } }, @@ -67211,7 +67358,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -67531,12 +67678,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "settlementAmount": { "type": "string", @@ -67862,7 +68009,7 @@ "summary": "Process a Push Funds Transfer", "description": "Receive funds using an Original Credit Transaction (OCT).\n", "tags": [ - "Push_Funds" + "Push Funds" ], "operationId": "createPushFundsTransfer", "x-devcenter-metaData": { @@ -67881,8 +68028,7 @@ "type": "object", "required": [ "orderInformation", - "processingInformation", - "senderInformation" + "processingInformation" ], "properties": { "clientReferenceInformation": { @@ -67892,21 +68038,25 @@ "code": { "type": "string", "maxLength": 50, + "x-nullable": true, "description": "Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction.\n" }, "applicationName": { "type": "string", "maxLength": 50, + "x-nullable": true, "description": "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n" }, "applicationVersion": { "type": "string", "maxLength": 50, + "x-nullable": true, "description": "Version of the CyberSource application or integration used for a transaction.\n" }, "applicationUser": { "type": "string", "maxLength": 60, + "x-nullable": true, "description": "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n" } } @@ -67927,27 +68077,24 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.\n\nThe disbursement amount. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant\u202fcurrency\u202fexponent. For example, a US Dollar $53 amount is a value of 5300.\n\nProcessor Amount Ranges:\nVisa Platform Connect: .01-9999999999.99\n\nMastercard Send: 1-9999999999.99\n\nFDC Compass: .01- 9999999999.99\n\nChase Paymentech: .01-9999999999.99\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.\n" }, "currency": { "type": "string", - "maxLength": 3, - "description": "Use a 3-character alpha currency code for currency of the sender.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n\nCurrency must be supported by the processor.\n" - } - } - }, - "isCryptocurrencyPurchase": { - "type": "string", - "maxLength": 5, - "description": "This indicates that the funds transfer is for a crypto currency transaction. Optional Y/y, true N/n, false\n" - }, - "surcharge": { - "type": "object", - "properties": { - "amount": { + "pattern": "^(\\s{0,3}|.{3})$", + "description": "Use a 3-character alpha currency code for currency of the funds transfer.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n\nCurrency must be supported by the processor.\n" + }, + "sourceCurrency": { "type": "string", - "maxLength": 8, - "description": "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\nIf the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer.\n\nNOTE: This field is supported only for Visa Platform Connect\n" + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Use a 3-character alpha currency code for source currency of the funds transfer. Supported for card and bank account based cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n" + }, + "destinationCurrency": { + "type": "string", + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Use a 3-character alpha currency code for destination currency of the funds transfer. Supported for card and bank account based cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\nNOTE: This field is supported only for Visa Platform Connect\n" } } } @@ -67955,82 +68102,27 @@ }, "processingInformation": { "type": "object", - "required": [ - "commerceIndicator" - ], "properties": { "businessApplicationId": { "type": "string", - "maxLength": 2, - "description": "\nPayouts transaction type.\nRequired for Mastercard Send.\n\nValid Values-\nVisa Platform Connect:\n- `AA`: Account to account.\n- `CP`: Card bill payment\n- `FD`: Funds disbursement (general)\n- `GD`: Government disbursement\n- `MD`: Merchant disbursement (acquirers or aggregators settling to merchants).\n- `PP`: Person to person.\n- `TU`: Top-up for enhanced prepaid loads.\n\n\nMastercard Send:\n- `BB`: Business to business.\n- `BD`: Business Disbursement\n- `CP`: Card bill payment\n- `GD`: Government disbursement\n- `MD`: Merchant disbursement (acquirers or aggregators settling to merchants).\n- `OG`: Online gambling payout.\n\n\nChase Paymentech Solutions:\n- `AA`: Account to account.\n- `FD`: Funds disbursement (general)\n- `MD`: Merchant disbursement (acquirers or aggregators settling to merchants).\n- `PP`: Person to person.\n\n\nFDC Compass:\n- `BB`: Business to business.\n- `BI`: Bank-initiated money transfer.\n- `FD`: Funds disbursement (general)\n- `GD`: Government disbursement\n- `GP`: Gambling Payment\n- `LO`: Loyalty Offers\n- `MD`: Merchant disbursement (acquirers or aggregators settling to merchants).\n- `MI`: Merchant initated money transfer\n- `OG`: Online gambling payout.\n- `PD`: Payroll pension disbursement.\n- `PP`: Person to person.\n- `WT`: Wallet transfer.\n" - }, - "commerceIndicator": { - "type": "string", - "maxLength": 13, - "description": "Type of transaction.\n\nValue for an OCT transaction:\ninternet\n\nFor details, see the e_commerce_indicator field description in Payouts Using the SCMP API.\n" - }, - "networkRoutingOrder": { - "type": "string", - "maxLength": 30, - "description": "Visa Platform Connect\nThis field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities.\n\nFor details, see the network_order field description in BIN Lookup Service Using the SCMP API.\n" + "x-nullable": true, + "pattern": "^(\\s{0,2}|.{2})$", + "description": "Payouts transaction type.\n\nBusiness Application ID:\n- `PP`: Person to person.\n- `FD`: Funds disbursement (general)\n" }, "payoutsOptions": { "type": "object", "properties": { - "accountFundingReferenceId": { + "sourceCurrency": { "type": "string", - "maxLength": 15, - "description": "Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request.\n\nApplicable only for Visa Platform Connect\n" + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Use a 3-character alpha currency code for source currency of the funds transfer.\n\nYellow Pepper\nSupported for cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n" }, - "retrievalReferenceNumber": { + "destinationCurrency": { "type": "string", - "maxLength": 12, - "description": "This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set.\n\nFormat: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 \u2013 366. Positions 5-12: A unique identification number generated by the merchant\n\nApplicable only for Visa Platform Connect\n" - } - } - }, - "purposeOfPayment": { - "type": "string", - "maxLength": 12, - "description": "This will send purpose of funds code for original credit transactions (OCTs).\n\nVisa Platform Connect (VPC)\nThis will send purpose of transaction code for original credit transactions (OCTs). Purpose of Payment codes are defined by the recipient issuer's country and vary by country.\n\nMastercard Send:\n- `00`: Family Support\n- `01`: Regular Labor Transfers (expatriates),\n- `02`: Travel & Tourism\n- `03`: Education\n- `04`: Hospitalization & Medical Treatment,\n- `05`: Emergency Need\n- `06`: Savings\n- `07`: Gifts\n- `08`: Other\n- `09`: Salary\n- `10`: Crowd lending\n- `11`: Crypto currency\n- `12`: Refund to original card\n- `13`: Refund to new card\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request.\n\nFor Payouts: max length for FDCCompass is String (22).\n" - }, - "recurringOptions": { - "type": "object", - "properties": { - "loanPayment": { - "type": "boolean", - "maxLength": 1, - "description": "boolean\nDefault: false\nFlag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n\ntrue: Loan payment\nfalse: (default) Not a loan payment\n\nThis field applies only to FDC Compass\n" - } - } - }, - "transactionReason": { - "type": "string", - "maxLength": 4, - "description": "Transaction reason code.\n\nThis field applies only to Visa Platform Connect\n" - } - } - }, - "processingOptions": { - "type": "object", - "properties": { - "fundingOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "type": { - "type": "string", - "maxLength": 1, - "description": "Visa Platform Connect :\nThis API will contain a code that denotes whether the customer identification data belongs to the sender or the recipient.\n\nThe valid values are:\n- `S` (Payer (sender))\n- `R` (Payee (recipient))\n\nThis field applies only to Visa Platform Connect\n" - } - } + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Use a 3-character alpha currency code for destination currency of the funds transfer.\n\nYellow Pepper\nSupported for cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n" } } } @@ -68047,19 +68139,19 @@ "properties": { "type": { "type": "string", - "maxLength": 3, - "description": "Three-digit value that indicates the card type. Mandatory if not present in a token.\n\nPossible values:\n\nVisa Platform Connect\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n- `033`: Visa Electron\n- `024`: Maestro\n\nMastercard Send:\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nFDC Compass:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nChase Paymentech:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n" + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, + "description": "Three-digit value that indicates the card type.\n\nPossible values:\n\nVisa Platform Connect\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n- `033`: Visa Electron\n- `024`: Maestro\n\nMastercard Send:\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nFDC Compass:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nChase Paymentech:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n\nYellow Pepper:\n- `001`: Visa\n- `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard.\n- `005`: Diners Club\n- `033`: Visa Electron\n- `024`: Intl Maestro\n" }, "securityCode": { "type": "string", - "maxLength": 3, + "pattern": "^(\\s{0,3}|.{3})$", "x-nullable": true, "description": "3-digit value that indicates the cardCvv2Value. Values can be 0-9.\n" }, "number": { "type": "string", - "minLength": 13, - "maxLength": 19, + "pattern": "^(\\s{0,19}|.{13,19})$", "x-nullable": true, "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n\nConditional: this field is required if not using tokens.\n" }, @@ -68080,6 +68172,7 @@ "properties": { "id": { "type": "string", + "x-nullable": true, "maxLength": 32, "description": "Unique identifier for the Customer token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional.\n" } @@ -68090,6 +68183,7 @@ "properties": { "id": { "type": "string", + "x-nullable": true, "maxLength": 32, "description": "Unique identifier for the Payment Instrument token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional.\n" } @@ -68100,6 +68194,7 @@ "properties": { "id": { "type": "string", + "x-nullable": true, "maxLength": 32, "description": "Unique identifier for the Instrument Identifier token used in the transaction. When you include this value in your request, many of the fields that can be supplied for an authorization or credit become optional.\n" } @@ -68112,39 +68207,44 @@ "address1": { "type": "string", "maxLength": 50, - "description": "First line of the recipient's address.\n\nRequired for Mastercard Send. This field is not supported for Visa Platform Connect.\n" + "x-nullable": true, + "description": "First line of the recipient's address.\nRequired for card payments\n" }, "address2": { "type": "string", "maxLength": 50, "x-nullable": true, - "description": "Second line of the recipient's address\n\nOptional for Mastercard Send. This field is not supported for Visa Platform Connect.\n" + "description": "Second line of the recipient's address\n" }, "locality": { "type": "string", "maxLength": 25, - "description": "Recipient city.\n\nRequired for Mastercard Send.\n" + "x-nullable": true, + "description": "Recipient city.\n" }, "postalCode": { "type": "string", + "x-nullable": true, "maxLength": 10, - "description": "Recipient postal code.\n\nFor USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.\n\nMastercard Send: Required for recipients in Canada and Canadian issued cards.\n" + "description": "Recipient postal code. \n\nFor USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.\n\nMandatory for card payments.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, "x-nullable": true, - "description": "The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO.\n\nRequired only for FDCCompass.\n\nThis field is not supported for Visa Platform Connect.\n" + "description": "The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nRequired for card payments.\n" }, "country": { "type": "string", - "maxLength": 2, - "description": "Recipient country code. Use the ISO Standard Alpha Country Codes.\n\nhttps://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nRequired for Mastercard Send.\n" + "pattern": "^(\\s{0,2}|.{2})$", + "x-nullable": true, + "description": "Recipient country code. Use the ISO Standard Alpha Country Codes.\n\nhttps://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n" }, "firstName": { "type": "string", "maxLength": 40, - "description": "First name of recipient.\n\nVisa Platform Connect (14)\nChase Paymentech (30)\nMastercard Send (40)\n\nThis field is required for Mastercard Send.\n" + "x-nullable": true, + "description": "First name of recipient.\n" }, "middleName": { "type": "string", @@ -68152,43 +68252,39 @@ "x-nullable": true, "description": "Sender's middle name. This field is a passthrough, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.\n" }, - "middleInitial": { - "type": "string", - "maxLength": 1, - "x-nullable": true, - "description": "Middle Initial of recipient.\n\nThis field is supported by FDC Compass.\n" - }, "lastName": { "type": "string", "maxLength": 40, "x-nullable": true, - "description": "Last name of recipient.\n\nVisa Platform Connect (14)\nPaymentech (30)\nMastercard Send (40)\n\nThis field is required for Mastercard Send.\n" - }, - "dateOfBirth": { - "type": "string", - "maxLength": 8, - "x-nullable": true, - "description": "Recipient date of birth in YYYYMMDD format.\n" + "description": "Last name of recipient.\n" }, "phoneNumber": { "type": "string", + "x-nullable": true, "maxLength": 20, "description": "Recipient phone number.\n\nThis field is supported by FDC Compass.\n\nMastercard Send: Max length is 15 with no dashes or spaces.\n" }, "personalIdentification": { "type": "object", + "x-nullable": true, "properties": { "id": { "type": "string", "x-nullable": true, "maxLength": 80, - "description": "The ID number/value.\n\nVisa 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\nMastercard Send(80)\n" + "description": "The ID number/value.\nProcessor(35)\n" }, "type": { "type": "string", "x-nullable": true, "maxLength": 4, - "description": "This tag will contain the type of sender identification. The valid values are:\n\nVisa Platform Connect:\n- `BTHD`: (Date of birth)\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `CPNY`: (Company registration number)\n- `PRXY`: (Proxy identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `LAWE`: (Law enforcement identification)\n- `MILI`: (Military identification)\n- `TRVL`: (Travel identification (non-passport))\n- `EMAL`: (Email)\n- `PHON`: (Phone number)\n\nMastercard Send:\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `EIDN`: (Employer Identification Number)\n- `IDNB`: (Identity Card Number)\n" + "description": "This tag will contain the type of sender identification.\n" + }, + "issuingCountry": { + "type": "string", + "x-nullable": true, + "pattern": "^(\\s{0,2}|.{2})$", + "description": "Issuing country of the identification.\nThe field format should be a 2 character ISO 3166-1 alpha-2 country code.\n" } } } @@ -68207,19 +68303,19 @@ "type": "string", "maxLength": 40, "x-nullable": true, - "description": "This field contains the first name of the entity funding the transaction.\n" + "description": "This field contains the first name of the entity funding the transaction\nMandatory for card payments\n" }, "lastName": { "type": "string", "maxLength": 40, "x-nullable": true, - "description": "This field contains the last name of the entity funding the transaction.\n" + "description": "This field contains the last name of the entity funding the transaction\nMandatory for card payments\n" }, "middleName": { "type": "string", "maxLength": 40, "x-nullable": true, - "description": "Supported only for Mastercard transactions. This field contains the middle name of the entity funding the transaction\n" + "description": "This field contains the middle name of the entity funding the transaction\n" }, "postalCode": { "type": "string", @@ -68231,40 +68327,36 @@ "type": "string", "maxLength": 60, "x-nullable": true, - "description": "Street address of sender.\n\nFunds Disbursement\n\nThis value is the address of the originator sending the funds disbursement.\n\nVisa Platform Connect\nRequired for transactions using business application id of AA, BI, PP, and WT.\n" + "description": "Street address of sender.\n\nFunds Disbursement\n\nThis value is the address of the originator sending the funds disbursement.\n\nRequired for card transactions\n" }, "address2": { "type": "string", "maxLength": 60, "x-nullable": true, - "description": "Used for additional address information. For example: Attention: Accounts Payable Optional field.\n\nThis field is supported for only Mastercard Send.\n" + "description": "Used for additional address information. For example: Attention: Accounts Payable \nOptional field.\n" }, "locality": { "type": "string", "maxLength": 25, "x-nullable": true, - "description": "The sender's city\n\nVisa Platform Connect\nRequired for transactions using business application id of AA, BI, PP, and WT.\n" + "description": "The sender's city\nMandatory for card payments\n" }, "administrativeArea": { "type": "string", "maxLength": 3, "x-nullable": true, - "description": "Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n" + "description": "Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nMandatory for card payments\n" }, "country": { "type": "string", - "maxLength": 2, + "pattern": "^(\\s{0,2}|.{2})$", "x-nullable": true, - "description": "Sender's country code. Use ISO Standard Alpha Country Codes.\n\nhttps://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nVisa Platform Connect\nRequired for transactions using business application id of AA, BI, PP, and WT.\n\nRequired for Mastercard Send\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n" + "description": "Sender's country code. Use ISO Standard Alpha Country Codes.\n\nhttps://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n" }, "dateOfBirth": { "type": "string", - "maxLength": 8, + "x-nullable": true, + "pattern": "^(\\s{0,8}|.{8})$", "description": "Sender's date of birth in YYYYMMDD format.\n" }, "phoneNumber": { @@ -68281,33 +68373,39 @@ "properties": { "type": { "type": "string", - "maxLength": 3, + "pattern": "^(\\s{0,3}|.{3})$", + "x-nullable": true, "description": "Three-digit value that indicates the card type.\n\nIMPORTANT It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type.\n\nPossible values:\n\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" }, "securityCode": { "type": "string", - "maxLength": 3, - "description": "3-digit value that indicates the card Cvv2Value. Values can be 0-9.\n\nThis field is supported in Mastercard Send.\n" + "x-nullable": true, + "pattern": "^(\\s{0,3}|.{3})$", + "description": "3-digit value that indicates the card Cvv2Value. Values can be 0-9.\n" }, "sourceAccountType": { "type": "string", + "x-nullable": true, "maxLength": 20, - "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process.\n\nValid values for Visa Platform Connect:\n- `CHECKING`: Checking account\n- `CREDIT`: Credit card account\n- `SAVING`: Saving account\n- `LINE_OF_CREDIT`: Line of credit or credit portion of combo card\n- `PREPAID`: Prepaid card account or prepaid portion of combo card\n- `UNIVERSAL`: Universal account\n\nValid values for Mastercard Send:\n- `00`: Other,\n- `01`: RTN + Bank Account,\n- `02`: IBAN,\n- `03`: Card Account,\n- `04`: Email,\n- `05`: Phone Number,\n- `06`: Bank account number (BAN) + Bank Identification \u0421ode (BIC),\n- `07`: Wallet ID,\n- `08`: Social Network ID. Numeric, 2 characters.\n\nThis field is supported in Mastercard Send.\n" + "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process.\n" }, "number": { "type": "string", + "x-nullable": true, "maxLength": 19, - "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n\nThis field is supported in Mastercard Send.\n" + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" }, "expirationMonth": { "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment card expires.\n\nFormat: MM.\n\nValid values: 01 through 12. Leading 0 is required.\n\nThis field is supported for Mastercard Send.\n" + "x-nullable": true, + "pattern": "^(\\s{0,2}|.{2})$", + "description": "Two-digit month in which the payment card expires.\n\nFormat: MM.\n\nValid values: 01 through 12. Leading 0 is required.\n" }, "expirationYear": { "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the payment card expires.\n\nThis field is supported for Mastercard Send.\n" + "x-nullable": true, + "pattern": "^(\\s{0,4}|.{4})$", + "description": "Four-digit year in which the payment card expires.\n" } } } @@ -68325,13 +68423,15 @@ "properties": { "fundsSource": { "type": "string", - "maxLength": 2, + "x-nullable": true, + "pattern": "^(\\s{0,2}|.{2})$", "description": "Source of funds. Possible values:\n\nChase Paymentech, FDC Compass, Visa Platform Connect:\n\n- `01`: Credit card\n- `02`: Debit card\n- `03`: Prepaid card\n\nChase Paymentech, Visa Platform Connect:\n\n- `04`: Cash\n- `05`: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, and proprietary debit or ATM cards.\n- `06`: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit.\n\nFDC Compass:\n- `04`: Deposit Account\n\nFunds Disbursement\nThis value is most likely 05 to identify that the originator used a deposit account to fund the disbursement.\n\nCredit Card Bill Payment\nThis value must be 02, 03, 04, or 05.\n" }, "number": { "type": "string", + "x-nullable": true, "maxLength": 34, - "description": "The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number.\n\nFunds disbursements\n\nThis field is optional.\n\nAll other transactions\n\nThis field is required when the sender funds the transaction with a financial instrument, for example debit card. Length:\n\nFDC Compass (<= 19)\nChase Paymentech (<= 16)\n" + "description": "The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number.\n\nFunds disbursements\n\nThis field is optional.\n\nAll other transactions\n\nThis field is required when the sender funds the transaction with a financial instrument, for example debit card. Length:\n" } } }, @@ -68342,191 +68442,30 @@ "id": { "type": "string", "maxLength": 80, - "description": "Visa Platform Connect(35)\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\nMastercard Send(80)\n" + "x-nullable": true, + "description": "Processor(35)\n" }, "personalIdType": { "type": "string", "maxLength": 1, + "x-nullable": true, "description": "Visa Platform Connect\nThis 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).\n\nThe valid values are: \u2022 B (Business) \u2022 I (Individual)\n" }, "type": { "type": "string", "maxLength": 4, - "description": "This tag will contain the type of sender identification. The valid values are:\n\nVisa Platform Connect:\n- `BTHD`: (Date of birth)\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `CPNY`: (Company registration number)\n- `PRXY`: (Proxy identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `LAWE`: (Law enforcement identification)\n- `MILI`: (Military identification)\n- `TRVL`: (Travel identification (non-passport))\n- `EMAL`: (Email)\n- `PHON`: (Phone number)\n\nMastercard Send:\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `EIDN`: (Employer Identification Number)\n- `IDNB`: (Identity Card Number)\n" - } - } - } - } - }, - "aggregatorInformation": { - "type": "object", - "properties": { - "aggregatorId": { - "type": "string", - "maxLength": 20, - "description": "Value that identifies you as a payment aggregator.\nGet this value from the processor.\n\nFDC Compass\nThis value must consist of uppercase letters.\n\nVisa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- `Record`: CP01 TCR6\n- `Position`: 95-105\n- `Field`: Market Identifier / Payment Facilitator ID\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Your payment aggregator business name.\n\nVisa Platform COnnect\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in Credit Card Services Using the SCMP API.\n" - }, - "subMerchant": { - "type": "object", - "properties": { - "id": { - "type": "string", - "maxLength": 20, - "description": "The ID you assigned to your sub-merchant.\n\nFDC Compass: This value must consist of uppercase characters.\n\nVisa Platform Connect with Mastercard: String (15)\nFDC Compass: String (20)\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Sub-merchant's business name.\n\nVisa Platform Connect\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "address1": { - "type": "string", - "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "locality": { - "type": "string", - "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant's state or province.\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Sub-merchant's country. Use the ISO Standard numeric Country Codes.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file.\n\nFDC Compass\nThis value must consist of uppercase characters.\n" - }, - "email": { - "type": "string", - "maxLength": 40, - "description": "Sub-merchant's email address.\n\nCyberSource through VisaNet |\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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" - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Sub-merchant's telephone number.\n\nMaximum length for procesors\n\nVisa Platform Connect: 20\nFDC Compass: 13\n\nFDC Compass\nThis value must consist of uppercase characters. Use one of these recommended formats:\nNNN-NNN-NNNN\nNNN-AAAAAAA\n" - } - } - } - } - }, - "merchantDefinedInformation": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference merchantDefinedInformation[1].key.\n\nFor Mastercard Send:\nName to be displayed in the reconciliation report for this disbursement. This value will appear as a header in the column name of the report.\n" - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see merchant_defined_data1 field description in the Credit Card Services Using the SCMP API Guide.\n\nWarning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\nFor Mastercard Send:\nValue to be displayed in the reconciliation report for this disbursement.\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "categoryCode": { - "type": "integer", - "maxLength": 4, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n\nRecord: CP01 TCR4\nPosition: 150-153\nField: Merchant Category Code\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 6, - "description": "Time that the transaction was submitted in local time. The time is in hhmmss format.\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\nVisa Platform Connect: max length is 20\n" - }, - "merchantDescriptor": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "The state where the merchant is located.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nNote This field is supported only for businesses located in the U.S. or Canada.\n" - }, - "contact": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see merchant_descriptor_contact field description in Credit Card Services Using the SCMP API.--> Contact information for the merchant.\n\nNote These are the maximum data lengths for the following payment processors:\n\nFDC Compass (13)\nChase Paymentech (13).\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Merchant's country.\n\nCountry code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder's statement.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nNote If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea.\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant's City.\n\nCity for your business location. This value might be displayed on the cardholder's statement.\n" - }, - "name": { - "type": "string", - "maxLength": 23, - "description": "Merchant's business name. This name is displayed on the cardholder's statement.\n\nChase Paymentech, Visa Platform Connect: length 22\n" - }, - "storeId": { - "type": "string", - "maxLength": 32, - "description": "The unique id of the merchant's shop which assigned by the merchant.\n" + "x-nullable": true, + "description": "This tag will contain the type of sender identification. The valid values are:\n\nVisa Platform Connect:\n- `BTHD`: (Date of birth)\n- `CUID`: (Customer identification (unspecified))\n- `NTID`: (National identification)\n- `PASN`: (Passport number)\n- `DRLN`: (Driver license)\n- `TXIN`: (Tax identification)\n- `CPNY`: (Company registration number)\n- `PRXY`: (Proxy identification)\n- `SSNB`: (Social security number)\n- `ARNB`: (Alien registration number)\n- `LAWE`: (Law enforcement identification)\n- `MILI`: (Military identification)\n- `TRVL`: (Travel identification (non-passport))\n- `EMAL`: (Email)\n- `PHON`: (Phone number)\n" }, - "postalCode": { + "issuingCountry": { + "x-nullable": true, "type": "string", - "maxLength": 14, - "description": "Merchant's postal code. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3\n" + "pattern": "^(\\s{0,2}|.{2})$", + "description": "Issuing country of the identification.\nThe field format should be a 2 character ISO 3166-1 alpha-2 country code.\n" } } } } - }, - "pointOfServiceInformation": { - "type": "object", - "properties": { - "terminalId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements.\n\nVisa Platform Connect\nA 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.\n\n\nUsed by\nAuthorization 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.\n\nChase Paymentech Solutions: Optional field. If you include this field in your request, you must also include pointOfSaleInformation.catLevel.\n" - }, - "catLevel": { - "type": "integer", - "maxLength": 1, - "description": "Type of cardholder-activated terminal. Possible values:\n\n- `1`: Automated dispensing machine\n- `2`: Self-service terminal\n- `3`: Limited amount terminal\n- `4`: In-flight commerce (IFC) terminal\n- `5`: Radio frequency device\n- `6`: Mobile acceptance terminal\n- `7`: Electronic cash register\n- `8`: E-commerce device at your location\n- `9`: Terminal or cash register that uses a dialup connection to connect to the transaction processing network\n\nChase Paymentech Solutions\nOnly values 1, 2, and 3 are supported.\nRequired if pointOfSaleInformation.terminalID is included in the request; otherwise, optional.\n\nVisa Platform COnnect\nValues 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values.\nOptional field.\n\nNonnegative integer.\n" - }, - "entryMode": { - "type": "string", - "maxLength": 11, - "description": "Method of entering payment card information into the POS terminal. Possible values:\n\n- `contact`: Read from direct contact with chip card.\n- `contactless`: Read from a contactless interface using chip data.\n- `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct.\n- `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct.\n- `swiped`: Read from credit card magnetic stripe.\nThe contact, contactless, and msd values are supported only for EMV transactions.\n" - }, - "pinEntryCapability": { - "type": "integer", - "maxLength": 1, - "description": "PIN Entry Capability\n- 0 Unknown.\n- 1 Indicates terminal can accept and forward online PINs.\n- 2 Indicates terminal cannot accept and forward online PINs.\n- 8 Terminal PIN pad down.\n- 9 Reserved for future use.\n" - }, - "terminalCapability": { - "type": "integer", - "maxLength": 1, - "description": "integer [ 1 .. 5 ]\nPOS terminal's capability. Possible values:\n\n- `1`: Terminal has a magnetic stripe reader only.\n- `2`: Terminal has a magnetic stripe reader and manual entry capability.\n- `3`: Terminal has manual entry capability only.\n- `4`: Terminal can read chip cards.\n- `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards.\nFor an EMV transaction, the value of this field must be 4 or 5.\n\nUsed by\nAuthorization Required for the following processors:\nChase Paymentech Solutions\n\nOptional for the following processors:\nVisa Platform Connect\n" - } - } } }, "example": { @@ -68537,44 +68476,19 @@ "applicationUser": "example_user" }, "orderInformation": { - "isCryptocurrencyPurchase": "true", "amountDetails": { "totalAmount": "53.00", - "currency": "AED" - }, - "surcharge": { - "amount": "54.00" + "currency": "AED", + "settlementCurrency": "USD" } }, "processingInformation": { - "commerceIndicator": "INTERNET", "businessApplicationId": "WT", - "networkRoutingOrder": "test", - "purposeOfPayment": "test", - "reconciliationId": "1234", - "transactionReason": "test", "payoutsOptions": { - "accountFundingReferenceId": "1234", - "retrievalReferenceNumber": "1234" - }, - "recurringOptions": { - "loanPayment": true - } - }, - "processingOptions": { - "fundingOptions": { - "initiator": { - "type": "S" - } + "sourceCurrency": "USD", + "destinationCurrency": "USD" } }, - "pointOfServiceInformation": { - "entryMode": "contact", - "pinEntryCapability": "1", - "terminalCapability": "1", - "catLevel": "1", - "terminalId": "123" - }, "recipientInformation": { "paymentInformation": { "card": { @@ -68599,13 +68513,11 @@ "locality": "Austin", "postalCode": "78731", "administrativeArea": "CA", - "country": "USA", + "country": "US", "firstName": "Jennifer", "lastName": "Doe", "middleName": "A", - "middleInitial": "M", "phoneNumber": "123 123-1234", - "dateOfBirth": "2000-12-12", "personalIdentification": { "id": "!23132456", "type": "CUID" @@ -68621,7 +68533,6 @@ "address2": "Bluffstone Drive", "locality": "Foster City", "administrativeArea": "CA", - "vatRegistrationNumber": "PQRS123423456", "phoneNumber": "123 123-1234", "dateOfBirth": "20001212", "country": "US", @@ -68645,38 +68556,6 @@ "fundsSource": "01", "number": "1234567890" } - }, - "aggregatorInformation": { - "aggregatorId": "123456", - "name": "abc", - "subMerchant": { - "address1": "Paseo Padre Boulevard", - "administrativeArea": "840", - "country": "US", - "email": "abc@abc", - "id": "1234", - "locality": "Foster City", - "name": "John", - "phoneNumber": "123 123-1234", - "postalCode": "94440" - } - }, - "merchantDefinedInformation": { - "key": "123", - "value": "abc" - }, - "merchantInformation": { - "categoryCode": "1234", - "submitLocalDateTime": "2021-08-19T10:07:57Z", - "vatRegistrationNumber": "PQRS123423456", - "merchantDescriptor": { - "administrativeArea": "840", - "contact": "Example", - "country": "US", - "locality": "Foster City", - "name": "John", - "postalCode": "94440" - } } } } @@ -68757,6 +68636,7 @@ "submitLocalDateTime": { "type": "string", "maxLength": 14, + "minLength": 14, "description": "Date and time at your physical location.\n\nFormat: YYYYMMDDhhmmss, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" } } @@ -68852,25 +68732,15 @@ "maxLength": 15, "description": "Transaction status from the processor.\n" }, - "approvalCode": { - "type": "string", - "maxLength": 6, - "description": "Issuer-generated approval code for the transaction.\n" - }, "systemTraceAuditNumber": { "type": "string", "maxLength": 6, - "description": "System audit number. Returned by authorization and incremental authorization services.\n\nVisa Platform Connect\n\nSystem trace number that must be printed on the customer's receipt.\n" - }, - "responseCodeSource": { - "type": "string", - "maxLength": 1, - "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n" + "description": "System audit number. Returned by authorization and incremental authorization services.\n" }, "retrievalReferenceNumber": { "type": "string", "maxLength": 24, - "description": "Unique reference number returned by the processor that identifies the transaction at the network.\n\nSupported by Mastercard Send\n" + "description": "Unique reference number returned by the processor that identifies the transaction at the network.\n" } } }, @@ -68887,7 +68757,7 @@ "type": "string", "minLength": 1, "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.\n\nNote For Visa Platform Conenct, FDC Compass, and Chase Paymentech processors, the maximum length for this field is 12 numbers.\n\nProcessor Amount Ranges:\nVisa Platform Connect: .01-9999999999.99\n\nMastercard Send: 1-9999999999.99\n\nFDC Compass: .01- 9999999999.994\n\nChase Paymentech: .01-9999999999.99\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.\n" }, "currency": { "type": "string", @@ -68993,9 +68863,7 @@ "processorInformation": { "transactionId": "1234567890", "responseCode": "1234567890", - "approvalCode": "123456", "systemTraceAuditNumber": "123456", - "responseCodeSource": "A", "retrievalReferenceNumber": "1234567890" }, "orderInformation": { @@ -69016,13 +68884,6 @@ "balance": "123", "currency": "USD" } - }, - "merchantInformation": { - "merchantDescriptor": { - "name": "John", - "locality": "Austin", - "country": "US" - } } } } @@ -69054,7 +68915,7 @@ }, "message": { "type": "string", - "description": "The detail message related to the status and reason listed above.\n\nPossible values:\n- Declined - One or more fields in the request contains invalid data\n- Declined - The request is missing one or more fields\n- Declined - There is a problem with your CyberSource merchant configuration.\n" + "description": "The detail message related to the status and reason listed above.\n\nPossible values:\n- One or more fields in the request contains invalid data.\n- The request is missing one or more required fields.\n- Declined - There is a problem with your CyberSource merchant configuration.\n" }, "details": { "type": "array", @@ -69176,43 +69037,14 @@ "applicationUser": "example_user" }, "orderInformation": { - "isCryptocurrencyPurchase": "true", "amountDetails": { "totalAmount": "53.00", - "currency": "AED" - }, - "surcharge": { - "amount": "54.00" + "currency": "USD", + "settlementCurrency": "USD" } }, "processingInformation": { - "commerceIndicator": "INTERNET", - "businessApplicationId": "WT", - "networkRoutingOrder": "test", - "purposeOfPayment": "test", - "reconciliationId": "1234", - "transactionReason": "test", - "payoutsOptions": { - "accountFundingReferenceId": "1234", - "retrievalReferenceNumber": "1234" - }, - "recurringOptions": { - "loanPayment": true - } - }, - "processingOptions": { - "fundingOptions": { - "initiator": { - "type": "S" - } - } - }, - "pointOfServiceInformation": { - "entryMode": "contact", - "pinEntryCapability": "1", - "terminalCapability": "1", - "catLevel": "1", - "terminalId": "123" + "businessApplicationId": "FT" }, "recipientInformation": { "paymentInformation": { @@ -69221,16 +69053,7 @@ "securityCode": "123", "number": "4111111111111111", "expirationMonth": "12", - "expirationYear": "2025", - "customer": { - "id": "40195947" - }, - "paymentInstrument": { - "id": "1234567783" - }, - "instrumentIdentifier": { - "id": "38792480110" - } + "expirationYear": "2025" } }, "address1": "8310 Capital of Texas Highwas North", @@ -69242,16 +69065,12 @@ "firstName": "Jennifer", "lastName": "Doe", "middleName": "A", - "middleInitial": "M", - "phoneNumber": "123 123-1234", - "dateOfBirth": "2000-12-12", "personalIdentification": { - "id": "!23132456", - "type": "CUID" + "id": "123132456", + "type": "EIDN" } }, "senderInformation": { - "name": "Tom", "firstName": "John", "lastName": "Doe", "middleName": "A", @@ -69260,9 +69079,6 @@ "address2": "Bluffstone Drive", "locality": "Foster City", "administrativeArea": "CA", - "vatRegistrationNumber": "PQRS123423456", - "phoneNumber": "123 123-1234", - "dateOfBirth": "20001212", "country": "US", "referenceNumber": "1234567890", "paymentInformation": { @@ -69277,44 +69093,10 @@ }, "personalIdentification": { "id": "123132456", - "personalIdType": "A", - "type": "BTHD" + "type": "CUID" }, "account": { - "fundsSource": "01", - "number": "1234567890" - } - }, - "aggregatorInformation": { - "aggregatorId": "123456", - "name": "abc", - "subMerchant": { - "address1": "Paseo Padre Boulevard", - "administrativeArea": "840", - "country": "US", - "email": "abc@abc", - "id": "1234", - "locality": "Foster City", - "name": "John", - "phoneNumber": "123 123-1234", - "postalCode": "94440" - } - }, - "merchantDefinedInformation": { - "key": "123", - "value": "abc" - }, - "merchantInformation": { - "categoryCode": "1234", - "submitLocalDateTime": "2021-08-19T10:07:57Z", - "vatRegistrationNumber": "PQRS123423456", - "merchantDescriptor": { - "administrativeArea": "840", - "contact": "Example", - "country": "US", - "locality": "Foster City", - "name": "John", - "postalCode": "94440" + "fundsSource": "02" } } } @@ -69454,7 +69236,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -69858,7 +69640,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -70068,7 +69850,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -70276,7 +70058,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -71246,7 +71028,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -71807,7 +71589,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -72110,7 +71892,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "billingAmount": { "type": "string", @@ -73356,12 +73138,12 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "hashedPassword": { "type": "string", "maxLength": 100, - "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n" } } }, @@ -73413,7 +73195,7 @@ "eciRaw": { "type": "string", "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI).\n\nFor details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Raw electronic commerce indicator (ECI).\n" }, "cavv": { "type": "string", @@ -73423,7 +73205,7 @@ "xid": { "type": "string", "maxLength": 40, - "description": "Transaction identifier.\n\nFor details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Transaction identifier.\n" }, "transactionId": { "type": "string", @@ -73565,12 +73347,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -73643,12 +73425,12 @@ "company": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" }, "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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": { "type": "string", @@ -73773,12 +73555,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "taxAmount": { "type": "string", @@ -73788,7 +73570,7 @@ "authorizedAmount": { "type": "string", "maxLength": 15, - "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API.\n" + "description": "Amount that was authorized.\n\nReturned by authorization service.\n\n#### PIN debit\nAmount of the purchase.\n\nReturned by PIN debit purchase.\n" }, "settlementAmount": { "type": "string", @@ -73863,7 +73645,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" }, "id": { "type": "string", @@ -74049,24 +73831,24 @@ "properties": { "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor 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" + "description": "Bank routing number. This is also called the transit number.\n" }, "branchCode": { "type": "string", - "description": "Code used to identify the branch of the customer's bank.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN. Use this field only when\nscoring a direct debit transaction.\n\nFor all possible values, see the `branch_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Code used to identify the branch of the customer's bank.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN. Use this field only when\nscoring a direct debit transaction.\n" }, "swiftCode": { "type": "string", - "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n" }, "bankCode": { "type": "string", - "description": "Country-specific code used to identify the customer's\nbank. Required for some countries if you do not or are not\nallowed to provide the IBAN instead. You can use this field\nonly when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Country-specific code used to identify the customer's\nbank. Required for some countries if you do not or are not\nallowed to provide the IBAN instead. You can use this field\nonly when scoring a direct debit transaction.\n" }, "iban": { "type": "string", "maxLength": 50, - "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.\n" }, "account": { "type": "object", @@ -74095,12 +73877,12 @@ }, "checkDigit": { "type": "string", - "description": "Code used to validate the customer's account number.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN instead. You may use this\nfield only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_check_digit` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + "description": "Code used to validate the customer's account number.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN instead. You may use this\nfield only when scoring a direct debit transaction.\n" }, "encoderId": { "type": "string", "maxLength": 3, - "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n" } } }, @@ -74252,16 +74034,16 @@ "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "commerceIndicatorLabel": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as `moto`\n" }, "businessApplicationId": { "type": "string", - "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n" }, "authorizationOptions": { "type": "object", @@ -74269,7 +74051,7 @@ "authType": { "type": "string", "maxLength": 15, - "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization.\n" }, "authIndicator": { "type": "string", @@ -74475,7 +74257,7 @@ "resultCode": { "type": "string", "maxLength": 1, - "description": "CVN result code.\n\nFor details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "CVN result code.\n" } } }, @@ -74485,12 +74267,12 @@ "resultCode": { "type": "string", "maxLength": 2, - "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Results from the ACH verification service.\n" }, "resultCodeRaw": { "type": "string", "maxLength": 10, - "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).\n" + "description": "Raw results from the ACH verification service.\n" } } }, @@ -74500,7 +74282,7 @@ "email": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's email address.\n\nFor details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's email address.\n" }, "emailRaw": { "type": "string", @@ -74520,7 +74302,7 @@ "phoneNumber": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's phone number.\n\nFor details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's phone number.\n" }, "phoneNumberRaw": { "type": "string", @@ -74530,7 +74312,7 @@ "street": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's street address.\n\nFor details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's street address.\n" }, "streetRaw": { "type": "string", @@ -74540,7 +74322,7 @@ "postalCode": { "type": "string", "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer's postal code.\n\nFor details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Mapped Electronic Verification response code for the customer's postal code.\n" }, "postalCodeRaw": { "type": "string", @@ -74841,7 +74623,7 @@ "solutionId": "89012345", "thirdPartyCertificationNumber": "123456789012" }, - "comments": "test comment" + "comments": "Test comment about this order - Expedited shipping" }, "consumerAuthenticationInformation": { "eciRaw": "02", @@ -75666,7 +75448,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" } } }, @@ -75704,7 +75486,7 @@ "xid": { "type": "string", "maxLength": 40, - "description": "Transaction identifier.\n\nFor details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Transaction identifier.\n" }, "transactionId": { "type": "string", @@ -75713,7 +75495,7 @@ "eciRaw": { "type": "string", "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI).\n\nFor details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Raw electronic commerce indicator (ECI).\n" } } }, @@ -75754,12 +75536,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -75798,7 +75580,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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": { "type": "string", @@ -75848,12 +75630,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -75880,7 +75662,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" } } }, @@ -75932,17 +75714,17 @@ }, "businessApplicationId": { "type": "string", - "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n" }, "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "commerceIndicatorLabel": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as `moto`\n" } } }, @@ -76507,7 +76289,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" } } }, @@ -76545,7 +76327,7 @@ "xid": { "type": "string", "maxLength": 40, - "description": "Transaction identifier.\n\nFor details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Transaction identifier.\n" }, "transactionId": { "type": "string", @@ -76554,7 +76336,7 @@ "eciRaw": { "type": "string", "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI).\n\nFor details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Raw electronic commerce indicator (ECI).\n" } } }, @@ -76595,12 +76377,12 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n" }, "value": { "type": "string", "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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" + "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" } } } @@ -76639,7 +76421,7 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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": { "type": "string", @@ -76689,12 +76471,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -76721,7 +76503,7 @@ "properties": { "customerId": { "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n" } } }, @@ -76773,17 +76555,17 @@ }, "businessApplicationId": { "type": "string", - "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n" }, "commerceIndicator": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" }, "commerceIndicatorLabel": { "type": "string", "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n" + "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value \n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as `moto`\n" } } }, @@ -84000,12 +83782,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -84013,7 +83795,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -84063,12 +83845,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -84116,7 +83898,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -84332,12 +84114,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -84345,7 +84127,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -84395,12 +84177,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -84453,7 +84235,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -85182,7 +84964,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" } } }, @@ -85207,12 +84989,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -85673,12 +85455,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -85686,7 +85468,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -85736,12 +85518,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -85794,7 +85576,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -85893,7 +85675,7 @@ "amount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" } } } @@ -86084,12 +85866,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -86097,7 +85879,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -86139,12 +85921,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "discountAmount": { "type": "string", @@ -86192,7 +85974,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -86407,12 +86189,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -86420,7 +86202,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -86470,12 +86252,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -86528,7 +86310,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -86997,12 +86779,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -87010,7 +86792,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -87060,12 +86842,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -87118,7 +86900,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -87534,12 +87316,12 @@ "email": { "type": "string", "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" + "description": "Customer's email address, including the full domain name.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n\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" }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "company": { "type": "object", @@ -87547,7 +87329,7 @@ "name": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" } } } @@ -87597,12 +87379,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "balanceAmount": { "type": "string", @@ -87655,7 +87437,7 @@ "amount": { "type": "string", "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n" }, "taxable": { "type": "boolean", @@ -88014,7 +87796,7 @@ "defaultCurrencyCode": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "payerAuthenticationInInvoicing": { "description": "For a merchant's invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are: \n- `enable`\n- `update`\n- `disable` \n", @@ -88130,7 +87912,7 @@ "defaultCurrencyCode": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "payerAuthentication3DSVersion": { "description": "The 3D Secure payer authentication status for a merchant's invoice payments.", @@ -88356,7 +88138,7 @@ "defaultCurrencyCode": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" }, "payerAuthentication3DSVersion": { "description": "The 3D Secure payer authentication status for a merchant's invoice payments.", @@ -88947,7 +88729,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." } } }, @@ -89003,7 +88785,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } }, @@ -89309,7 +89091,7 @@ "vatRegistrationNumber": { "type": "string", "maxLength": 20, - "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" } } } @@ -89523,12 +89305,12 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" }, "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -89877,7 +89659,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -89947,7 +89729,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\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\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" + "description": "Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\n#### Used by\n**Authorization**\nRequired field.\n\n**Authorization Reversal**\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#### PIN Debit\nCurrency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\nReturned by PIN debit purchase.\n\nFor PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.\nFor the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit.\n\n#### DCC for First Data\nYour local currency.\n\n#### Tax Calculation\nRequired for international tax and value added tax only.\nOptional for U.S. and Canadian taxes.\nYour local currency.\n" } } } @@ -90079,7 +89861,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90147,7 +89929,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90478,7 +90260,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90551,7 +90333,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90714,7 +90496,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -90787,7 +90569,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -91262,7 +91044,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -91331,7 +91113,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -91505,7 +91287,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", @@ -91582,7 +91364,7 @@ }, "comments": { "type": "string", - "description": "Comments" + "description": "Brief description of the order or any comment you wish to add to the order." }, "partner": { "type": "object", diff --git a/lib/Model/GetAllPlansResponseOrderInformationAmountDetails.php b/lib/Model/GetAllPlansResponseOrderInformationAmountDetails.php index 6897b10e3..f2cd713a6 100644 --- a/lib/Model/GetAllPlansResponseOrderInformationAmountDetails.php +++ b/lib/Model/GetAllPlansResponseOrderInformationAmountDetails.php @@ -182,7 +182,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.php b/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.php index ae772cdf2..1c424bfe1 100644 --- a/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.php +++ b/lib/Model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.php @@ -350,7 +350,7 @@ public function getDefaultCurrencyCode() /** * Sets defaultCurrencyCode - * @param string $defaultCurrencyCode Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $defaultCurrencyCode Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setDefaultCurrencyCode($defaultCurrencyCode) diff --git a/lib/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.php b/lib/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.php index aca032c71..d531a5d6a 100644 --- a/lib/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.php +++ b/lib/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.php @@ -197,7 +197,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @return $this */ public function setMerchantCustomerId($merchantCustomerId) diff --git a/lib/Model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.php b/lib/Model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.php index b5967b54e..001a860bb 100644 --- a/lib/Model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.php +++ b/lib/Model/InvoicingV2InvoicesAllGet200ResponseOrderInformationAmountDetails.php @@ -177,7 +177,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -198,7 +198,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/InvoicingV2InvoicesGet200ResponseTransactionDetails.php b/lib/Model/InvoicingV2InvoicesGet200ResponseTransactionDetails.php index f0d5b7092..637a08532 100644 --- a/lib/Model/InvoicingV2InvoicesGet200ResponseTransactionDetails.php +++ b/lib/Model/InvoicingV2InvoicesGet200ResponseTransactionDetails.php @@ -198,7 +198,7 @@ public function getAmount() /** * Sets amount - * @param string $amount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $amount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setAmount($amount) diff --git a/lib/Model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.php b/lib/Model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.php index cb02e6836..71398f6a0 100644 --- a/lib/Model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.php +++ b/lib/Model/InvoicingV2InvoicesPost201ResponseOrderInformationAmountDetails.php @@ -219,7 +219,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -240,7 +240,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.php b/lib/Model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.php index 3a63501d5..19c83a65d 100644 --- a/lib/Model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.php +++ b/lib/Model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.php @@ -350,7 +350,7 @@ public function getDefaultCurrencyCode() /** * Sets defaultCurrencyCode - * @param string $defaultCurrencyCode Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $defaultCurrencyCode Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setDefaultCurrencyCode($defaultCurrencyCode) diff --git a/lib/Model/Invoicingv2invoicesCustomerInformation.php b/lib/Model/Invoicingv2invoicesCustomerInformation.php index 1fd372ee5..d52ac1546 100644 --- a/lib/Model/Invoicingv2invoicesCustomerInformation.php +++ b/lib/Model/Invoicingv2invoicesCustomerInformation.php @@ -210,7 +210,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) @@ -231,7 +231,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @return $this */ public function setMerchantCustomerId($merchantCustomerId) diff --git a/lib/Model/Invoicingv2invoicesCustomerInformationCompany.php b/lib/Model/Invoicingv2invoicesCustomerInformationCompany.php index de7f07fe4..af93dc328 100644 --- a/lib/Model/Invoicingv2invoicesCustomerInformationCompany.php +++ b/lib/Model/Invoicingv2invoicesCustomerInformationCompany.php @@ -170,7 +170,7 @@ public function getName() /** * Sets name - * @param string $name Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $name Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @return $this */ public function setName($name) diff --git a/lib/Model/Invoicingv2invoicesOrderInformationAmountDetails.php b/lib/Model/Invoicingv2invoicesOrderInformationAmountDetails.php index 39d09bb14..f17103e1a 100644 --- a/lib/Model/Invoicingv2invoicesOrderInformationAmountDetails.php +++ b/lib/Model/Invoicingv2invoicesOrderInformationAmountDetails.php @@ -213,7 +213,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -234,7 +234,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.php b/lib/Model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.php index 49eb0b267..99f475e78 100644 --- a/lib/Model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.php +++ b/lib/Model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.php @@ -183,7 +183,7 @@ public function getAmount() /** * Sets amount - * @param string $amount Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * @param string $amount Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. * @return $this */ public function setAmount($amount) diff --git a/lib/Model/Kmsv2keyssymClientReferenceInformation.php b/lib/Model/Kmsv2keyssymClientReferenceInformation.php index 552ee1d67..1f8c7c404 100644 --- a/lib/Model/Kmsv2keyssymClientReferenceInformation.php +++ b/lib/Model/Kmsv2keyssymClientReferenceInformation.php @@ -203,7 +203,7 @@ public function getComments() /** * Sets comments - * @param string $comments Comments + * @param string $comments Brief description of the order or any comment you wish to add to the order. * @return $this */ public function setComments($comments) diff --git a/lib/Model/PatchInstrumentIdentifierRequest.php b/lib/Model/PatchInstrumentIdentifierRequest.php index fb4576962..2930b74f3 100644 --- a/lib/Model/PatchInstrumentIdentifierRequest.php +++ b/lib/Model/PatchInstrumentIdentifierRequest.php @@ -58,7 +58,7 @@ class PatchInstrumentIdentifierRequest implements ArrayAccess 'object' => 'string', 'state' => 'string', 'type' => 'string', - 'tokenProvisioningInformation' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', + 'tokenProvisioningInformation' => '\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'card' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierCard', 'bankAccount' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierBankAccount', 'tokenizedCard' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenizedCard', @@ -326,7 +326,7 @@ public function getType() /** * Sets type - * @param string $type The type of Instrument Identifier. Possible Values: - enrollable card + * @param string $type The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token * @return $this */ public function setType($type) @@ -338,7 +338,7 @@ public function setType($type) /** * Gets tokenProvisioningInformation - * @return \CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation + * @return \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation */ public function getTokenProvisioningInformation() { @@ -347,7 +347,7 @@ public function getTokenProvisioningInformation() /** * Sets tokenProvisioningInformation - * @param \CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation $tokenProvisioningInformation + * @param \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation $tokenProvisioningInformation * @return $this */ public function setTokenProvisioningInformation($tokenProvisioningInformation) diff --git a/lib/Model/PostInstrumentIdentifierEnrollmentRequest.php b/lib/Model/PostInstrumentIdentifierEnrollmentRequest.php index 2b2aac2e4..79c19eccc 100644 --- a/lib/Model/PostInstrumentIdentifierEnrollmentRequest.php +++ b/lib/Model/PostInstrumentIdentifierEnrollmentRequest.php @@ -58,7 +58,7 @@ class PostInstrumentIdentifierEnrollmentRequest implements ArrayAccess 'object' => 'string', 'state' => 'string', 'type' => 'string', - 'tokenProvisioningInformation' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', + 'tokenProvisioningInformation' => '\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'card' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierCard', 'bankAccount' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierBankAccount', 'tokenizedCard' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenizedCard', @@ -326,7 +326,7 @@ public function getType() /** * Sets type - * @param string $type The type of Instrument Identifier. Possible Values: - enrollable card + * @param string $type The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token * @return $this */ public function setType($type) @@ -338,7 +338,7 @@ public function setType($type) /** * Gets tokenProvisioningInformation - * @return \CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation + * @return \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation */ public function getTokenProvisioningInformation() { @@ -347,7 +347,7 @@ public function getTokenProvisioningInformation() /** * Sets tokenProvisioningInformation - * @param \CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation $tokenProvisioningInformation + * @param \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation $tokenProvisioningInformation * @return $this */ public function setTokenProvisioningInformation($tokenProvisioningInformation) diff --git a/lib/Model/PostInstrumentIdentifierRequest.php b/lib/Model/PostInstrumentIdentifierRequest.php index f7843b34a..b19f361c9 100644 --- a/lib/Model/PostInstrumentIdentifierRequest.php +++ b/lib/Model/PostInstrumentIdentifierRequest.php @@ -58,7 +58,7 @@ class PostInstrumentIdentifierRequest implements ArrayAccess 'object' => 'string', 'state' => 'string', 'type' => 'string', - 'tokenProvisioningInformation' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', + 'tokenProvisioningInformation' => '\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'card' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierCard', 'bankAccount' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierBankAccount', 'tokenizedCard' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenizedCard', @@ -326,7 +326,7 @@ public function getType() /** * Sets type - * @param string $type The type of Instrument Identifier. Possible Values: - enrollable card + * @param string $type The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token * @return $this */ public function setType($type) @@ -338,7 +338,7 @@ public function setType($type) /** * Gets tokenProvisioningInformation - * @return \CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation + * @return \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation */ public function getTokenProvisioningInformation() { @@ -347,7 +347,7 @@ public function getTokenProvisioningInformation() /** * Sets tokenProvisioningInformation - * @param \CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation $tokenProvisioningInformation + * @param \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation $tokenProvisioningInformation * @return $this */ public function setTokenProvisioningInformation($tokenProvisioningInformation) diff --git a/lib/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.php b/lib/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.php index 4f6fffec2..59d5ac5b1 100644 --- a/lib/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.php +++ b/lib/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.php @@ -197,7 +197,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.php b/lib/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.php index db25b88b2..e8d753646 100644 --- a/lib/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.php +++ b/lib/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.php @@ -170,7 +170,7 @@ public function getSettlementMethod() /** * Sets settlementMethod - * @param string $settlementMethod Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $settlementMethod Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) * @return $this */ public function setSettlementMethod($settlementMethod) diff --git a/lib/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.php b/lib/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.php index 160716d5a..bf5fb140e 100644 --- a/lib/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.php +++ b/lib/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.php @@ -203,7 +203,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.php b/lib/Model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.php index 7fa22dfce..406ac1f51 100644 --- a/lib/Model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.php +++ b/lib/Model/PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification.php @@ -176,7 +176,7 @@ public function getType() /** * Sets type - * @param string $type The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $type The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. * @return $this */ public function setType($type) @@ -197,7 +197,7 @@ public function getId() /** * Sets id - * @param string $id The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. + * @param string $id The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. * @return $this */ public function setId($id) diff --git a/lib/Model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.php b/lib/Model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.php index e2fa982d5..85ccdbcad 100644 --- a/lib/Model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.php +++ b/lib/Model/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.php @@ -176,7 +176,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) diff --git a/lib/Model/PtsV2PaymentsPost201Response1OrderInformationBillTo.php b/lib/Model/PtsV2PaymentsPost201Response1OrderInformationBillTo.php index ed088883c..88e23571b 100644 --- a/lib/Model/PtsV2PaymentsPost201Response1OrderInformationBillTo.php +++ b/lib/Model/PtsV2PaymentsPost201Response1OrderInformationBillTo.php @@ -419,7 +419,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.php b/lib/Model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.php index 44c26fc1b..97575e097 100644 --- a/lib/Model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.php +++ b/lib/Model/PtsV2PaymentsPost201Response2OrderInformationAmountDetails.php @@ -170,7 +170,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) diff --git a/lib/Model/PtsV2PaymentsPost201ResponseBuyerInformation.php b/lib/Model/PtsV2PaymentsPost201ResponseBuyerInformation.php index ca1d5cf9f..c1be6a2bb 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponseBuyerInformation.php +++ b/lib/Model/PtsV2PaymentsPost201ResponseBuyerInformation.php @@ -200,7 +200,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @return $this */ public function setMerchantCustomerId($merchantCustomerId) @@ -221,7 +221,7 @@ public function getDateOfBirth() /** * Sets dateOfBirth - * @param string $dateOfBirth Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $dateOfBirth 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. * @return $this */ public function setDateOfBirth($dateOfBirth) @@ -242,7 +242,7 @@ public function getVatRegistrationNumber() /** * Sets vatRegistrationNumber - * @param string $vatRegistrationNumber Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * @param string $vatRegistrationNumber Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. * @return $this */ public function setVatRegistrationNumber($vatRegistrationNumber) diff --git a/lib/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.php b/lib/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.php index 0cb4a77b6..3b2f2e8ba 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.php +++ b/lib/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.php @@ -500,7 +500,7 @@ public function getAuthenticationPath() /** * Sets authenticationPath - * @param string $authenticationPath Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) + * @param string $authenticationPath Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. * @return $this */ public function setAuthenticationPath($authenticationPath) @@ -920,7 +920,7 @@ public function getProofXml() /** * Sets proofXml - * @param string $proofXml Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. + * @param string $proofXml Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. * @return $this */ public function setProofXml($proofXml) @@ -1109,7 +1109,7 @@ public function getVeresEnrolled() /** * Sets veresEnrolled - * @param string $veresEnrolled Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) + * @param string $veresEnrolled Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. * @return $this */ public function setVeresEnrolled($veresEnrolled) diff --git a/lib/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.php b/lib/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.php index 50b39d733..1fb4362f8 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.php +++ b/lib/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.php @@ -257,7 +257,7 @@ public function getAuthorizedAmount() /** * Sets authorizedAmount - * @param string $authorizedAmount Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. + * @param string $authorizedAmount Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. * @return $this */ public function setAuthorizedAmount($authorizedAmount) @@ -278,7 +278,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformation.php b/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformation.php index 4b69ae14a..9bf95d743 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformation.php +++ b/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformation.php @@ -416,7 +416,7 @@ public function getScheme() /** * Sets scheme - * @param string $scheme Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $scheme Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. * @return $this */ public function setScheme($scheme) @@ -437,7 +437,7 @@ public function getBin() /** * Sets bin - * @param string $bin Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $bin Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. * @return $this */ public function setBin($bin) @@ -458,7 +458,7 @@ public function getAccountType() /** * Sets accountType - * @param string $accountType Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $accountType Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. * @return $this */ public function setAccountType($accountType) @@ -479,7 +479,7 @@ public function getIssuer() /** * Sets issuer - * @param string $issuer Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $issuer Name of the bank or entity that issued the card account. * @return $this */ public function setIssuer($issuer) @@ -500,7 +500,7 @@ public function getBinCountry() /** * Sets binCountry - * @param string $binCountry Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $binCountry Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. * @return $this */ public function setBinCountry($binCountry) diff --git a/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.php b/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.php index 526c26a30..6ab5686a5 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.php +++ b/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.php @@ -197,7 +197,7 @@ public function getCorrectedRoutingNumber() /** * Sets correctedRoutingNumber - * @param string $correctedRoutingNumber Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $correctedRoutingNumber Corrected account number from the ACH verification service. * @return $this */ public function setCorrectedRoutingNumber($correctedRoutingNumber) diff --git a/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.php b/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.php index f1f5fa3b9..01dc2cb5b 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.php +++ b/lib/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.php @@ -170,7 +170,7 @@ public function getCorrectedAccountNumber() /** * Sets correctedAccountNumber - * @param string $correctedAccountNumber Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $correctedAccountNumber Corrected account number from the ACH verification service. * @return $this */ public function setCorrectedAccountNumber($correctedAccountNumber) diff --git a/lib/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.php b/lib/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.php index 5c325e327..aa46dbc23 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.php +++ b/lib/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.php @@ -176,7 +176,7 @@ public function getSettlementMethod() /** * Sets settlementMethod - * @param string $settlementMethod Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $settlementMethod Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) * @return $this */ public function setSettlementMethod($settlementMethod) @@ -197,7 +197,7 @@ public function getFraudScreeningLevel() /** * Sets fraudScreeningLevel - * @param string $fraudScreeningLevel Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). + * @param string $fraudScreeningLevel Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification * @return $this */ public function setFraudScreeningLevel($fraudScreeningLevel) diff --git a/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.php b/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.php index 52380aed6..f7c7abce3 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.php +++ b/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.php @@ -176,7 +176,7 @@ public function getResultCode() /** * Sets resultCode - * @param string $resultCode Results from the ACH verification service. For details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). + * @param string $resultCode Results from the ACH verification service. * @return $this */ public function setResultCode($resultCode) @@ -197,7 +197,7 @@ public function getResultCodeRaw() /** * Sets resultCodeRaw - * @param string $resultCodeRaw Raw results from the ACH verification service. For details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). + * @param string $resultCodeRaw Raw results from the ACH verification service. * @return $this */ public function setResultCodeRaw($resultCodeRaw) diff --git a/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.php b/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.php index 66106c1be..e014fb76d 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.php +++ b/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.php @@ -176,7 +176,7 @@ public function getResultCode() /** * Sets resultCode - * @param string $resultCode CVN result code. For details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $resultCode CVN result code. * @return $this */ public function setResultCode($resultCode) diff --git a/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.php b/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.php index a7fa72957..6f7b7c7ff 100644 --- a/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.php +++ b/lib/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.php @@ -272,7 +272,7 @@ public function getCode() /** * Sets code - * @param string $code Mapped Electronic Verification response code for the customer's name. For details, see `auth_ev_name` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $code Mapped Electronic Verification response code for the customer's name. * @return $this */ public function setCode($code) @@ -314,7 +314,7 @@ public function getEmail() /** * Sets email - * @param string $email Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $email Mapped Electronic Verification response code for the customer's email address. * @return $this */ public function setEmail($email) @@ -356,7 +356,7 @@ public function getPhoneNumber() /** * Sets phoneNumber - * @param string $phoneNumber Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $phoneNumber Mapped Electronic Verification response code for the customer's phone number. * @return $this */ public function setPhoneNumber($phoneNumber) @@ -398,7 +398,7 @@ public function getPostalCode() /** * Sets postalCode - * @param string $postalCode Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $postalCode Mapped Electronic Verification response code for the customer's postal code. * @return $this */ public function setPostalCode($postalCode) @@ -440,7 +440,7 @@ public function getStreet() /** * Sets street - * @param string $street Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $street Mapped Electronic Verification response code for the customer's street address. * @return $this */ public function setStreet($street) diff --git a/lib/Model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.php b/lib/Model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.php index b473a467b..fc576e292 100644 --- a/lib/Model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.php +++ b/lib/Model/PtsV2PaymentsRefundPost201ResponseOrderInformationAmountDetails.php @@ -236,7 +236,7 @@ public function getExchangeRate() /** * Sets exchangeRate - * @param string $exchangeRate Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [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) + * @param string $exchangeRate Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. * @return $this */ public function setExchangeRate($exchangeRate) @@ -257,7 +257,7 @@ public function getForeignAmount() /** * Sets foreignAmount - * @param string $foreignAmount Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $foreignAmount Set this field to the converted amount that was returned by the DCC provider. * @return $this */ public function setForeignAmount($foreignAmount) diff --git a/lib/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.php b/lib/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.php index fcc20fdac..d51dbf5d1 100644 --- a/lib/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.php +++ b/lib/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.php @@ -224,7 +224,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.php b/lib/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.php index 8cb5c9f31..9fcf1c858 100644 --- a/lib/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.php +++ b/lib/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.php @@ -224,7 +224,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.php b/lib/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.php index ccee29d76..34929cb9b 100644 --- a/lib/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.php +++ b/lib/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.php @@ -224,7 +224,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.php b/lib/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.php index 8d79609f0..dcea363d0 100644 --- a/lib/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.php +++ b/lib/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.php @@ -188,7 +188,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -209,7 +209,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/Ptsv1pushfundstransferAggregatorInformation.php b/lib/Model/Ptsv1pushfundstransferAggregatorInformation.php deleted file mode 100644 index e880cb775..000000000 --- a/lib/Model/Ptsv1pushfundstransferAggregatorInformation.php +++ /dev/null @@ -1,299 +0,0 @@ - 'string', - 'name' => 'string', - 'subMerchant' => '\CyberSource\Model\Ptsv1pushfundstransferAggregatorInformationSubMerchant' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'aggregatorId' => null, - 'name' => null, - 'subMerchant' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'aggregatorId' => 'aggregatorId', - 'name' => 'name', - 'subMerchant' => 'subMerchant' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'aggregatorId' => 'setAggregatorId', - 'name' => 'setName', - 'subMerchant' => 'setSubMerchant' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'aggregatorId' => 'getAggregatorId', - 'name' => 'getName', - 'subMerchant' => 'getSubMerchant' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['aggregatorId'] = isset($data['aggregatorId']) ? $data['aggregatorId'] : null; - $this->container['name'] = isset($data['name']) ? $data['name'] : null; - $this->container['subMerchant'] = isset($data['subMerchant']) ? $data['subMerchant'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets aggregatorId - * @return string - */ - public function getAggregatorId() - { - return $this->container['aggregatorId']; - } - - /** - * Sets aggregatorId - * @param string $aggregatorId Value that identifies you as a payment aggregator. Get this value from the processor. FDC Compass This value must consist of uppercase letters. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - `Record`: CP01 TCR6 - `Position`: 95-105 - `Field`: Market Identifier / Payment Facilitator ID - * @return $this - */ - public function setAggregatorId($aggregatorId) - { - $this->container['aggregatorId'] = $aggregatorId; - - return $this; - } - - /** - * Gets name - * @return string - */ - public function getName() - { - return $this->container['name']; - } - - /** - * Sets name - * @param string $name Your payment aggregator business name. Visa Platform COnnect With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in Credit Card Services Using the SCMP API. - * @return $this - */ - public function setName($name) - { - $this->container['name'] = $name; - - return $this; - } - - /** - * Gets subMerchant - * @return \CyberSource\Model\Ptsv1pushfundstransferAggregatorInformationSubMerchant - */ - public function getSubMerchant() - { - return $this->container['subMerchant']; - } - - /** - * Sets subMerchant - * @param \CyberSource\Model\Ptsv1pushfundstransferAggregatorInformationSubMerchant $subMerchant - * @return $this - */ - public function setSubMerchant($subMerchant) - { - $this->container['subMerchant'] = $subMerchant; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.php b/lib/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.php deleted file mode 100644 index 58f366f53..000000000 --- a/lib/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.php +++ /dev/null @@ -1,461 +0,0 @@ - 'string', - 'name' => 'string', - 'address1' => 'string', - 'locality' => 'string', - 'administrativeArea' => 'string', - 'postalCode' => 'string', - 'country' => 'string', - 'email' => 'string', - 'phoneNumber' => 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'id' => null, - 'name' => null, - 'address1' => null, - 'locality' => null, - 'administrativeArea' => null, - 'postalCode' => null, - 'country' => null, - 'email' => null, - 'phoneNumber' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'id' => 'id', - 'name' => 'name', - 'address1' => 'address1', - 'locality' => 'locality', - 'administrativeArea' => 'administrativeArea', - 'postalCode' => 'postalCode', - 'country' => 'country', - 'email' => 'email', - 'phoneNumber' => 'phoneNumber' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'id' => 'setId', - 'name' => 'setName', - 'address1' => 'setAddress1', - 'locality' => 'setLocality', - 'administrativeArea' => 'setAdministrativeArea', - 'postalCode' => 'setPostalCode', - 'country' => 'setCountry', - 'email' => 'setEmail', - 'phoneNumber' => 'setPhoneNumber' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'id' => 'getId', - 'name' => 'getName', - 'address1' => 'getAddress1', - 'locality' => 'getLocality', - 'administrativeArea' => 'getAdministrativeArea', - 'postalCode' => 'getPostalCode', - 'country' => 'getCountry', - 'email' => 'getEmail', - 'phoneNumber' => 'getPhoneNumber' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['id'] = isset($data['id']) ? $data['id'] : null; - $this->container['name'] = isset($data['name']) ? $data['name'] : null; - $this->container['address1'] = isset($data['address1']) ? $data['address1'] : null; - $this->container['locality'] = isset($data['locality']) ? $data['locality'] : null; - $this->container['administrativeArea'] = isset($data['administrativeArea']) ? $data['administrativeArea'] : null; - $this->container['postalCode'] = isset($data['postalCode']) ? $data['postalCode'] : null; - $this->container['country'] = isset($data['country']) ? $data['country'] : null; - $this->container['email'] = isset($data['email']) ? $data['email'] : null; - $this->container['phoneNumber'] = isset($data['phoneNumber']) ? $data['phoneNumber'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets id - * @return string - */ - public function getId() - { - return $this->container['id']; - } - - /** - * Sets id - * @param string $id The ID you assigned to your sub-merchant. FDC Compass: This value must consist of uppercase characters. Visa Platform Connect with Mastercard: String (15) FDC Compass: String (20) - * @return $this - */ - public function setId($id) - { - $this->container['id'] = $id; - - return $this; - } - - /** - * Gets name - * @return string - */ - public function getName() - { - return $this->container['name']; - } - - /** - * Sets name - * @param string $name Sub-merchant's business name. Visa Platform Connect With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. - * @return $this - */ - public function setName($name) - { - $this->container['name'] = $name; - - return $this; - } - - /** - * Gets address1 - * @return string - */ - public function getAddress1() - { - return $this->container['address1']; - } - - /** - * Sets address1 - * @param string $address1 First line of the sub-merchant's street address. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. - * @return $this - */ - public function setAddress1($address1) - { - $this->container['address1'] = $address1; - - return $this; - } - - /** - * Gets locality - * @return string - */ - public function getLocality() - { - return $this->container['locality']; - } - - /** - * Sets locality - * @param string $locality Sub-merchant's city. For processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. - * @return $this - */ - public function setLocality($locality) - { - $this->container['locality'] = $locality; - - return $this; - } - - /** - * Gets administrativeArea - * @return string - */ - public function getAdministrativeArea() - { - return $this->container['administrativeArea']; - } - - /** - * Sets administrativeArea - * @param string $administrativeArea Sub-merchant's state or province. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. - * @return $this - */ - public function setAdministrativeArea($administrativeArea) - { - $this->container['administrativeArea'] = $administrativeArea; - - return $this; - } - - /** - * Gets postalCode - * @return string - */ - public function getPostalCode() - { - return $this->container['postalCode']; - } - - /** - * Sets postalCode - * @param string $postalCode Partial postal code for the sub-merchant's address. For processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. - * @return $this - */ - public function setPostalCode($postalCode) - { - $this->container['postalCode'] = $postalCode; - - return $this; - } - - /** - * Gets country - * @return string - */ - public function getCountry() - { - return $this->container['country']; - } - - /** - * Sets country - * @param string $country Sub-merchant's country. Use the ISO Standard numeric Country Codes. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. - * @return $this - */ - public function setCountry($country) - { - $this->container['country'] = $country; - - return $this; - } - - /** - * Gets email - * @return string - */ - public function getEmail() - { - return $this->container['email']; - } - - /** - * Sets email - * @param string $email Sub-merchant's email address. CyberSource through VisaNet | With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address - Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. - * @return $this - */ - public function setEmail($email) - { - $this->container['email'] = $email; - - return $this; - } - - /** - * Gets phoneNumber - * @return string - */ - public function getPhoneNumber() - { - return $this->container['phoneNumber']; - } - - /** - * Sets phoneNumber - * @param string $phoneNumber Sub-merchant's telephone number. Maximum length for procesors Visa Platform Connect: 20 FDC Compass: 13 FDC Compass This value must consist of uppercase characters. Use one of these recommended formats: NNN-NNN-NNNN NNN-AAAAAAA - * @return $this - */ - public function setPhoneNumber($phoneNumber) - { - $this->container['phoneNumber'] = $phoneNumber; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferMerchantDefinedInformation.php b/lib/Model/Ptsv1pushfundstransferMerchantDefinedInformation.php deleted file mode 100644 index 5ad55add1..000000000 --- a/lib/Model/Ptsv1pushfundstransferMerchantDefinedInformation.php +++ /dev/null @@ -1,272 +0,0 @@ - 'string', - 'value' => 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'key' => null, - 'value' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'key' => 'key', - 'value' => 'value' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'key' => 'setKey', - 'value' => 'setValue' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'key' => 'getKey', - 'value' => 'getValue' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['key'] = isset($data['key']) ? $data['key'] : null; - $this->container['value'] = isset($data['value']) ? $data['value'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets key - * @return string - */ - public function getKey() - { - return $this->container['key']; - } - - /** - * Sets key - * @param string $key The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference merchantDefinedInformation[1].key. For Mastercard Send: Name to be displayed in the reconciliation report for this disbursement. This value will appear as a header in the column name of the report. - * @return $this - */ - public function setKey($key) - { - $this->container['key'] = $key; - - return $this; - } - - /** - * Gets value - * @return string - */ - public function getValue() - { - return $this->container['value']; - } - - /** - * Sets value - * @param string $value The value you assign for your merchant-defined data field. For details, see merchant_defined_data1 field description in the Credit Card Services Using the SCMP API Guide. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. For Mastercard Send: Value to be displayed in the reconciliation report for this disbursement. - * @return $this - */ - public function setValue($value) - { - $this->container['value'] = $value; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferMerchantInformation.php b/lib/Model/Ptsv1pushfundstransferMerchantInformation.php deleted file mode 100644 index 5a7a639a7..000000000 --- a/lib/Model/Ptsv1pushfundstransferMerchantInformation.php +++ /dev/null @@ -1,326 +0,0 @@ - 'int', - 'submitLocalDateTime' => 'string', - 'vatRegistrationNumber' => 'string', - 'merchantDescriptor' => '\CyberSource\Model\Ptsv1pushfundstransferMerchantInformationMerchantDescriptor' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'categoryCode' => null, - 'submitLocalDateTime' => null, - 'vatRegistrationNumber' => null, - 'merchantDescriptor' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'categoryCode' => 'categoryCode', - 'submitLocalDateTime' => 'submitLocalDateTime', - 'vatRegistrationNumber' => 'vatRegistrationNumber', - 'merchantDescriptor' => 'merchantDescriptor' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'categoryCode' => 'setCategoryCode', - 'submitLocalDateTime' => 'setSubmitLocalDateTime', - 'vatRegistrationNumber' => 'setVatRegistrationNumber', - 'merchantDescriptor' => 'setMerchantDescriptor' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'categoryCode' => 'getCategoryCode', - 'submitLocalDateTime' => 'getSubmitLocalDateTime', - 'vatRegistrationNumber' => 'getVatRegistrationNumber', - 'merchantDescriptor' => 'getMerchantDescriptor' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['categoryCode'] = isset($data['categoryCode']) ? $data['categoryCode'] : null; - $this->container['submitLocalDateTime'] = isset($data['submitLocalDateTime']) ? $data['submitLocalDateTime'] : null; - $this->container['vatRegistrationNumber'] = isset($data['vatRegistrationNumber']) ? $data['vatRegistrationNumber'] : null; - $this->container['merchantDescriptor'] = isset($data['merchantDescriptor']) ? $data['merchantDescriptor'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets categoryCode - * @return int - */ - public function getCategoryCode() - { - return $this->container['categoryCode']; - } - - /** - * Sets categoryCode - * @param int $categoryCode The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR4 Position: 150-153 Field: Merchant Category Code - * @return $this - */ - public function setCategoryCode($categoryCode) - { - $this->container['categoryCode'] = $categoryCode; - - return $this; - } - - /** - * Gets submitLocalDateTime - * @return string - */ - public function getSubmitLocalDateTime() - { - return $this->container['submitLocalDateTime']; - } - - /** - * Sets submitLocalDateTime - * @param string $submitLocalDateTime Time that the transaction was submitted in local time. The time is in hhmmss format. - * @return $this - */ - public function setSubmitLocalDateTime($submitLocalDateTime) - { - $this->container['submitLocalDateTime'] = $submitLocalDateTime; - - return $this; - } - - /** - * Gets vatRegistrationNumber - * @return string - */ - public function getVatRegistrationNumber() - { - return $this->container['vatRegistrationNumber']; - } - - /** - * Sets vatRegistrationNumber - * @param string $vatRegistrationNumber Your government-assigned tax identification number. Visa Platform Connect: max length is 20 - * @return $this - */ - public function setVatRegistrationNumber($vatRegistrationNumber) - { - $this->container['vatRegistrationNumber'] = $vatRegistrationNumber; - - return $this; - } - - /** - * Gets merchantDescriptor - * @return \CyberSource\Model\Ptsv1pushfundstransferMerchantInformationMerchantDescriptor - */ - public function getMerchantDescriptor() - { - return $this->container['merchantDescriptor']; - } - - /** - * Sets merchantDescriptor - * @param \CyberSource\Model\Ptsv1pushfundstransferMerchantInformationMerchantDescriptor $merchantDescriptor - * @return $this - */ - public function setMerchantDescriptor($merchantDescriptor) - { - $this->container['merchantDescriptor'] = $merchantDescriptor; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.php b/lib/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.php deleted file mode 100644 index b4dea70ef..000000000 --- a/lib/Model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.php +++ /dev/null @@ -1,407 +0,0 @@ - 'string', - 'contact' => 'string', - 'country' => 'string', - 'locality' => 'string', - 'name' => 'string', - 'storeId' => 'string', - 'postalCode' => 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'administrativeArea' => null, - 'contact' => null, - 'country' => null, - 'locality' => null, - 'name' => null, - 'storeId' => null, - 'postalCode' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'administrativeArea' => 'administrativeArea', - 'contact' => 'contact', - 'country' => 'country', - 'locality' => 'locality', - 'name' => 'name', - 'storeId' => 'storeId', - 'postalCode' => 'postalCode' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'administrativeArea' => 'setAdministrativeArea', - 'contact' => 'setContact', - 'country' => 'setCountry', - 'locality' => 'setLocality', - 'name' => 'setName', - 'storeId' => 'setStoreId', - 'postalCode' => 'setPostalCode' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'administrativeArea' => 'getAdministrativeArea', - 'contact' => 'getContact', - 'country' => 'getCountry', - 'locality' => 'getLocality', - 'name' => 'getName', - 'storeId' => 'getStoreId', - 'postalCode' => 'getPostalCode' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['administrativeArea'] = isset($data['administrativeArea']) ? $data['administrativeArea'] : null; - $this->container['contact'] = isset($data['contact']) ? $data['contact'] : null; - $this->container['country'] = isset($data['country']) ? $data['country'] : null; - $this->container['locality'] = isset($data['locality']) ? $data['locality'] : null; - $this->container['name'] = isset($data['name']) ? $data['name'] : null; - $this->container['storeId'] = isset($data['storeId']) ? $data['storeId'] : null; - $this->container['postalCode'] = isset($data['postalCode']) ? $data['postalCode'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets administrativeArea - * @return string - */ - public function getAdministrativeArea() - { - return $this->container['administrativeArea']; - } - - /** - * Sets administrativeArea - * @param string $administrativeArea The state where the merchant is located. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Note This field is supported only for businesses located in the U.S. or Canada. - * @return $this - */ - public function setAdministrativeArea($administrativeArea) - { - $this->container['administrativeArea'] = $administrativeArea; - - return $this; - } - - /** - * Gets contact - * @return string - */ - public function getContact() - { - return $this->container['contact']; - } - - /** - * Sets contact - * @param string $contact For the descriptions, used-by information, data types, and lengths for these fields, see merchant_descriptor_contact field description in Credit Card Services Using the SCMP API.--> Contact information for the merchant. Note These are the maximum data lengths for the following payment processors: FDC Compass (13) Chase Paymentech (13). - * @return $this - */ - public function setContact($contact) - { - $this->container['contact'] = $contact; - - return $this; - } - - /** - * Gets country - * @return string - */ - public function getCountry() - { - return $this->container['country']; - } - - /** - * Sets country - * @param string $country Merchant's country. Country code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder's statement. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Note If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea. - * @return $this - */ - public function setCountry($country) - { - $this->container['country'] = $country; - - return $this; - } - - /** - * Gets locality - * @return string - */ - public function getLocality() - { - return $this->container['locality']; - } - - /** - * Sets locality - * @param string $locality Merchant's City. City for your business location. This value might be displayed on the cardholder's statement. - * @return $this - */ - public function setLocality($locality) - { - $this->container['locality'] = $locality; - - return $this; - } - - /** - * Gets name - * @return string - */ - public function getName() - { - return $this->container['name']; - } - - /** - * Sets name - * @param string $name Merchant's business name. This name is displayed on the cardholder's statement. Chase Paymentech, Visa Platform Connect: length 22 - * @return $this - */ - public function setName($name) - { - $this->container['name'] = $name; - - return $this; - } - - /** - * Gets storeId - * @return string - */ - public function getStoreId() - { - return $this->container['storeId']; - } - - /** - * Sets storeId - * @param string $storeId The unique id of the merchant's shop which assigned by the merchant. - * @return $this - */ - public function setStoreId($storeId) - { - $this->container['storeId'] = $storeId; - - return $this; - } - - /** - * Gets postalCode - * @return string - */ - public function getPostalCode() - { - return $this->container['postalCode']; - } - - /** - * Sets postalCode - * @param string $postalCode Merchant's postal code. This value might be displayed on the cardholder's statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789 If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3 - * @return $this - */ - public function setPostalCode($postalCode) - { - $this->container['postalCode'] = $postalCode; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferOrderInformation.php b/lib/Model/Ptsv1pushfundstransferOrderInformation.php index 75eaaf2b7..b281121ba 100644 --- a/lib/Model/Ptsv1pushfundstransferOrderInformation.php +++ b/lib/Model/Ptsv1pushfundstransferOrderInformation.php @@ -53,9 +53,7 @@ class Ptsv1pushfundstransferOrderInformation implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'amountDetails' => '\CyberSource\Model\Ptsv1pushfundstransferOrderInformationAmountDetails', - 'isCryptocurrencyPurchase' => 'string', - 'surcharge' => '\CyberSource\Model\Ptsv1pushfundstransferOrderInformationSurcharge' + 'amountDetails' => '\CyberSource\Model\Ptsv1pushfundstransferOrderInformationAmountDetails' ]; /** @@ -63,9 +61,7 @@ class Ptsv1pushfundstransferOrderInformation implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'amountDetails' => null, - 'isCryptocurrencyPurchase' => null, - 'surcharge' => null + 'amountDetails' => null ]; public static function swaggerTypes() @@ -83,9 +79,7 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'amountDetails' => 'amountDetails', - 'isCryptocurrencyPurchase' => 'isCryptocurrencyPurchase', - 'surcharge' => 'surcharge' + 'amountDetails' => 'amountDetails' ]; @@ -94,9 +88,7 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'amountDetails' => 'setAmountDetails', - 'isCryptocurrencyPurchase' => 'setIsCryptocurrencyPurchase', - 'surcharge' => 'setSurcharge' + 'amountDetails' => 'setAmountDetails' ]; @@ -105,9 +97,7 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'amountDetails' => 'getAmountDetails', - 'isCryptocurrencyPurchase' => 'getIsCryptocurrencyPurchase', - 'surcharge' => 'getSurcharge' + 'amountDetails' => 'getAmountDetails' ]; public static function attributeMap() @@ -142,8 +132,6 @@ public static function getters() public function __construct(array $data = null) { $this->container['amountDetails'] = isset($data['amountDetails']) ? $data['amountDetails'] : null; - $this->container['isCryptocurrencyPurchase'] = isset($data['isCryptocurrencyPurchase']) ? $data['isCryptocurrencyPurchase'] : null; - $this->container['surcharge'] = isset($data['surcharge']) ? $data['surcharge'] : null; } /** @@ -197,48 +185,6 @@ public function setAmountDetails($amountDetails) return $this; } - - /** - * Gets isCryptocurrencyPurchase - * @return string - */ - public function getIsCryptocurrencyPurchase() - { - return $this->container['isCryptocurrencyPurchase']; - } - - /** - * Sets isCryptocurrencyPurchase - * @param string $isCryptocurrencyPurchase This indicates that the funds transfer is for a crypto currency transaction. Optional Y/y, true N/n, false - * @return $this - */ - public function setIsCryptocurrencyPurchase($isCryptocurrencyPurchase) - { - $this->container['isCryptocurrencyPurchase'] = $isCryptocurrencyPurchase; - - return $this; - } - - /** - * Gets surcharge - * @return \CyberSource\Model\Ptsv1pushfundstransferOrderInformationSurcharge - */ - public function getSurcharge() - { - return $this->container['surcharge']; - } - - /** - * Sets surcharge - * @param \CyberSource\Model\Ptsv1pushfundstransferOrderInformationSurcharge $surcharge - * @return $this - */ - public function setSurcharge($surcharge) - { - $this->container['surcharge'] = $surcharge; - - return $this; - } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Ptsv1pushfundstransferOrderInformationAmountDetails.php b/lib/Model/Ptsv1pushfundstransferOrderInformationAmountDetails.php index 22f8d579f..a4e231793 100644 --- a/lib/Model/Ptsv1pushfundstransferOrderInformationAmountDetails.php +++ b/lib/Model/Ptsv1pushfundstransferOrderInformationAmountDetails.php @@ -54,7 +54,9 @@ class Ptsv1pushfundstransferOrderInformationAmountDetails implements ArrayAccess */ protected static $swaggerTypes = [ 'totalAmount' => 'string', - 'currency' => 'string' + 'currency' => 'string', + 'sourceCurrency' => 'string', + 'destinationCurrency' => 'string' ]; /** @@ -63,7 +65,9 @@ class Ptsv1pushfundstransferOrderInformationAmountDetails implements ArrayAccess */ protected static $swaggerFormats = [ 'totalAmount' => null, - 'currency' => null + 'currency' => null, + 'sourceCurrency' => null, + 'destinationCurrency' => null ]; public static function swaggerTypes() @@ -82,7 +86,9 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'totalAmount' => 'totalAmount', - 'currency' => 'currency' + 'currency' => 'currency', + 'sourceCurrency' => 'sourceCurrency', + 'destinationCurrency' => 'destinationCurrency' ]; @@ -92,7 +98,9 @@ public static function swaggerFormats() */ protected static $setters = [ 'totalAmount' => 'setTotalAmount', - 'currency' => 'setCurrency' + 'currency' => 'setCurrency', + 'sourceCurrency' => 'setSourceCurrency', + 'destinationCurrency' => 'setDestinationCurrency' ]; @@ -102,7 +110,9 @@ public static function swaggerFormats() */ protected static $getters = [ 'totalAmount' => 'getTotalAmount', - 'currency' => 'getCurrency' + 'currency' => 'getCurrency', + 'sourceCurrency' => 'getSourceCurrency', + 'destinationCurrency' => 'getDestinationCurrency' ]; public static function attributeMap() @@ -138,6 +148,8 @@ public function __construct(array $data = null) { $this->container['totalAmount'] = isset($data['totalAmount']) ? $data['totalAmount'] : null; $this->container['currency'] = isset($data['currency']) ? $data['currency'] : null; + $this->container['sourceCurrency'] = isset($data['sourceCurrency']) ? $data['sourceCurrency'] : null; + $this->container['destinationCurrency'] = isset($data['destinationCurrency']) ? $data['destinationCurrency'] : null; } /** @@ -188,7 +200,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. The disbursement amount. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant currency exponent. For example, a US Dollar $53 amount is a value of 5300. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.99 Chase Paymentech: .01-9999999999.99 + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * @return $this */ public function setTotalAmount($totalAmount) @@ -209,7 +221,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Use a 3-character alpha currency code for currency of the sender. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. + * @param string $currency Use a 3-character alpha currency code for currency of the funds transfer. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. * @return $this */ public function setCurrency($currency) @@ -218,6 +230,48 @@ public function setCurrency($currency) return $this; } + + /** + * Gets sourceCurrency + * @return string + */ + public function getSourceCurrency() + { + return $this->container['sourceCurrency']; + } + + /** + * Sets sourceCurrency + * @param string $sourceCurrency Use a 3-character alpha currency code for source currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf + * @return $this + */ + public function setSourceCurrency($sourceCurrency) + { + $this->container['sourceCurrency'] = $sourceCurrency; + + return $this; + } + + /** + * Gets destinationCurrency + * @return string + */ + public function getDestinationCurrency() + { + return $this->container['destinationCurrency']; + } + + /** + * Sets destinationCurrency + * @param string $destinationCurrency Use a 3-character alpha currency code for destination currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf NOTE: This field is supported only for Visa Platform Connect + * @return $this + */ + public function setDestinationCurrency($destinationCurrency) + { + $this->container['destinationCurrency'] = $destinationCurrency; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Ptsv1pushfundstransferOrderInformationSurcharge.php b/lib/Model/Ptsv1pushfundstransferOrderInformationSurcharge.php deleted file mode 100644 index f9fef691c..000000000 --- a/lib/Model/Ptsv1pushfundstransferOrderInformationSurcharge.php +++ /dev/null @@ -1,245 +0,0 @@ - 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'amount' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'amount' => 'amount' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'amount' => 'setAmount' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'amount' => 'getAmount' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['amount'] = isset($data['amount']) ? $data['amount'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets amount - * @return string - */ - public function getAmount() - { - return $this->container['amount']; - } - - /** - * Sets amount - * @param string $amount The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer. NOTE: This field is supported only for Visa Platform Connect - * @return $this - */ - public function setAmount($amount) - { - $this->container['amount'] = $amount; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferPointOfServiceInformation.php b/lib/Model/Ptsv1pushfundstransferPointOfServiceInformation.php deleted file mode 100644 index e9036a14f..000000000 --- a/lib/Model/Ptsv1pushfundstransferPointOfServiceInformation.php +++ /dev/null @@ -1,353 +0,0 @@ - 'string', - 'catLevel' => 'int', - 'entryMode' => 'string', - 'pinEntryCapability' => 'int', - 'terminalCapability' => 'int' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'terminalId' => null, - 'catLevel' => null, - 'entryMode' => null, - 'pinEntryCapability' => null, - 'terminalCapability' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'terminalId' => 'terminalId', - 'catLevel' => 'catLevel', - 'entryMode' => 'entryMode', - 'pinEntryCapability' => 'pinEntryCapability', - 'terminalCapability' => 'terminalCapability' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'terminalId' => 'setTerminalId', - 'catLevel' => 'setCatLevel', - 'entryMode' => 'setEntryMode', - 'pinEntryCapability' => 'setPinEntryCapability', - 'terminalCapability' => 'setTerminalCapability' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'terminalId' => 'getTerminalId', - 'catLevel' => 'getCatLevel', - 'entryMode' => 'getEntryMode', - 'pinEntryCapability' => 'getPinEntryCapability', - 'terminalCapability' => 'getTerminalCapability' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['terminalId'] = isset($data['terminalId']) ? $data['terminalId'] : null; - $this->container['catLevel'] = isset($data['catLevel']) ? $data['catLevel'] : null; - $this->container['entryMode'] = isset($data['entryMode']) ? $data['entryMode'] : null; - $this->container['pinEntryCapability'] = isset($data['pinEntryCapability']) ? $data['pinEntryCapability'] : null; - $this->container['terminalCapability'] = isset($data['terminalCapability']) ? $data['terminalCapability'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets terminalId - * @return string - */ - public function getTerminalId() - { - return $this->container['terminalId']; - } - - /** - * Sets terminalId - * @param string $terminalId Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. Visa Platform Connect 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. 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. Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include pointOfSaleInformation.catLevel. - * @return $this - */ - public function setTerminalId($terminalId) - { - $this->container['terminalId'] = $terminalId; - - return $this; - } - - /** - * Gets catLevel - * @return int - */ - public function getCatLevel() - { - return $this->container['catLevel']; - } - - /** - * Sets catLevel - * @param int $catLevel 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. Visa Platform COnnect Values 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values. Optional field. Nonnegative integer. - * @return $this - */ - public function setCatLevel($catLevel) - { - $this->container['catLevel'] = $catLevel; - - return $this; - } - - /** - * Gets entryMode - * @return string - */ - public function getEntryMode() - { - return $this->container['entryMode']; - } - - /** - * Sets entryMode - * @param string $entryMode 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. - * @return $this - */ - public function setEntryMode($entryMode) - { - $this->container['entryMode'] = $entryMode; - - return $this; - } - - /** - * Gets pinEntryCapability - * @return int - */ - public function getPinEntryCapability() - { - return $this->container['pinEntryCapability']; - } - - /** - * Sets pinEntryCapability - * @param int $pinEntryCapability PIN Entry Capability - 0 Unknown. - 1 Indicates terminal can accept and forward online PINs. - 2 Indicates terminal cannot accept and forward online PINs. - 8 Terminal PIN pad down. - 9 Reserved for future use. - * @return $this - */ - public function setPinEntryCapability($pinEntryCapability) - { - $this->container['pinEntryCapability'] = $pinEntryCapability; - - return $this; - } - - /** - * Gets terminalCapability - * @return int - */ - public function getTerminalCapability() - { - return $this->container['terminalCapability']; - } - - /** - * Sets terminalCapability - * @param int $terminalCapability integer [ 1 .. 5 ] 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. Used by Authorization Required for the following processors: Chase Paymentech Solutions Optional for the following processors: Visa Platform Connect - * @return $this - */ - public function setTerminalCapability($terminalCapability) - { - $this->container['terminalCapability'] = $terminalCapability; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferProcessingInformation.php b/lib/Model/Ptsv1pushfundstransferProcessingInformation.php index 94c8393e8..cb7f48582 100644 --- a/lib/Model/Ptsv1pushfundstransferProcessingInformation.php +++ b/lib/Model/Ptsv1pushfundstransferProcessingInformation.php @@ -54,13 +54,7 @@ class Ptsv1pushfundstransferProcessingInformation implements ArrayAccess */ protected static $swaggerTypes = [ 'businessApplicationId' => 'string', - 'commerceIndicator' => 'string', - 'networkRoutingOrder' => 'string', - 'payoutsOptions' => '\CyberSource\Model\Ptsv1pushfundstransferProcessingInformationPayoutsOptions', - 'purposeOfPayment' => 'string', - 'reconciliationId' => 'string', - 'recurringOptions' => '\CyberSource\Model\Ptsv1pushfundstransferProcessingInformationRecurringOptions', - 'transactionReason' => 'string' + 'payoutsOptions' => '\CyberSource\Model\Ptsv1pushfundstransferProcessingInformationPayoutsOptions' ]; /** @@ -69,13 +63,7 @@ class Ptsv1pushfundstransferProcessingInformation implements ArrayAccess */ protected static $swaggerFormats = [ 'businessApplicationId' => null, - 'commerceIndicator' => null, - 'networkRoutingOrder' => null, - 'payoutsOptions' => null, - 'purposeOfPayment' => null, - 'reconciliationId' => null, - 'recurringOptions' => null, - 'transactionReason' => null + 'payoutsOptions' => null ]; public static function swaggerTypes() @@ -94,13 +82,7 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'businessApplicationId' => 'businessApplicationId', - 'commerceIndicator' => 'commerceIndicator', - 'networkRoutingOrder' => 'networkRoutingOrder', - 'payoutsOptions' => 'payoutsOptions', - 'purposeOfPayment' => 'purposeOfPayment', - 'reconciliationId' => 'reconciliationId', - 'recurringOptions' => 'recurringOptions', - 'transactionReason' => 'transactionReason' + 'payoutsOptions' => 'payoutsOptions' ]; @@ -110,13 +92,7 @@ public static function swaggerFormats() */ protected static $setters = [ 'businessApplicationId' => 'setBusinessApplicationId', - 'commerceIndicator' => 'setCommerceIndicator', - 'networkRoutingOrder' => 'setNetworkRoutingOrder', - 'payoutsOptions' => 'setPayoutsOptions', - 'purposeOfPayment' => 'setPurposeOfPayment', - 'reconciliationId' => 'setReconciliationId', - 'recurringOptions' => 'setRecurringOptions', - 'transactionReason' => 'setTransactionReason' + 'payoutsOptions' => 'setPayoutsOptions' ]; @@ -126,13 +102,7 @@ public static function swaggerFormats() */ protected static $getters = [ 'businessApplicationId' => 'getBusinessApplicationId', - 'commerceIndicator' => 'getCommerceIndicator', - 'networkRoutingOrder' => 'getNetworkRoutingOrder', - 'payoutsOptions' => 'getPayoutsOptions', - 'purposeOfPayment' => 'getPurposeOfPayment', - 'reconciliationId' => 'getReconciliationId', - 'recurringOptions' => 'getRecurringOptions', - 'transactionReason' => 'getTransactionReason' + 'payoutsOptions' => 'getPayoutsOptions' ]; public static function attributeMap() @@ -167,13 +137,7 @@ public static function getters() public function __construct(array $data = null) { $this->container['businessApplicationId'] = isset($data['businessApplicationId']) ? $data['businessApplicationId'] : null; - $this->container['commerceIndicator'] = isset($data['commerceIndicator']) ? $data['commerceIndicator'] : null; - $this->container['networkRoutingOrder'] = isset($data['networkRoutingOrder']) ? $data['networkRoutingOrder'] : null; $this->container['payoutsOptions'] = isset($data['payoutsOptions']) ? $data['payoutsOptions'] : null; - $this->container['purposeOfPayment'] = isset($data['purposeOfPayment']) ? $data['purposeOfPayment'] : null; - $this->container['reconciliationId'] = isset($data['reconciliationId']) ? $data['reconciliationId'] : null; - $this->container['recurringOptions'] = isset($data['recurringOptions']) ? $data['recurringOptions'] : null; - $this->container['transactionReason'] = isset($data['transactionReason']) ? $data['transactionReason'] : null; } /** @@ -185,9 +149,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if ($this->container['commerceIndicator'] === null) { - $invalid_properties[] = "'commerceIndicator' can't be null"; - } return $invalid_properties; } @@ -200,9 +161,6 @@ public function listInvalidProperties() public function valid() { - if ($this->container['commerceIndicator'] === null) { - return false; - } return true; } @@ -218,7 +176,7 @@ public function getBusinessApplicationId() /** * Sets businessApplicationId - * @param string $businessApplicationId Payouts transaction type. Required for Mastercard Send. Valid Values- Visa Platform Connect: - `AA`: Account to account. - `CP`: Card bill payment - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. - `TU`: Top-up for enhanced prepaid loads. Mastercard Send: - `BB`: Business to business. - `BD`: Business Disbursement - `CP`: Card bill payment - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `OG`: Online gambling payout. Chase Paymentech Solutions: - `AA`: Account to account. - `FD`: Funds disbursement (general) - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. FDC Compass: - `BB`: Business to business. - `BI`: Bank-initiated money transfer. - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `GP`: Gambling Payment - `LO`: Loyalty Offers - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `MI`: Merchant initated money transfer - `OG`: Online gambling payout. - `PD`: Payroll pension disbursement. - `PP`: Person to person. - `WT`: Wallet transfer. + * @param string $businessApplicationId Payouts transaction type. Business Application ID: - `PP`: Person to person. - `FD`: Funds disbursement (general) * @return $this */ public function setBusinessApplicationId($businessApplicationId) @@ -228,48 +186,6 @@ public function setBusinessApplicationId($businessApplicationId) return $this; } - /** - * Gets commerceIndicator - * @return string - */ - public function getCommerceIndicator() - { - return $this->container['commerceIndicator']; - } - - /** - * Sets commerceIndicator - * @param string $commerceIndicator Type of transaction. Value for an OCT transaction: internet For details, see the e_commerce_indicator field description in Payouts Using the SCMP API. - * @return $this - */ - public function setCommerceIndicator($commerceIndicator) - { - $this->container['commerceIndicator'] = $commerceIndicator; - - return $this; - } - - /** - * Gets networkRoutingOrder - * @return string - */ - public function getNetworkRoutingOrder() - { - return $this->container['networkRoutingOrder']; - } - - /** - * Sets networkRoutingOrder - * @param string $networkRoutingOrder Visa Platform Connect This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. For details, see the network_order field description in BIN Lookup Service Using the SCMP API. - * @return $this - */ - public function setNetworkRoutingOrder($networkRoutingOrder) - { - $this->container['networkRoutingOrder'] = $networkRoutingOrder; - - return $this; - } - /** * Gets payoutsOptions * @return \CyberSource\Model\Ptsv1pushfundstransferProcessingInformationPayoutsOptions @@ -290,90 +206,6 @@ public function setPayoutsOptions($payoutsOptions) return $this; } - - /** - * Gets purposeOfPayment - * @return string - */ - public function getPurposeOfPayment() - { - return $this->container['purposeOfPayment']; - } - - /** - * Sets purposeOfPayment - * @param string $purposeOfPayment This will send purpose of funds code for original credit transactions (OCTs). Visa Platform Connect (VPC) This will send purpose of transaction code for original credit transactions (OCTs). Purpose of Payment codes are defined by the recipient issuer's country and vary by country. Mastercard Send: - `00`: Family Support - `01`: Regular Labor Transfers (expatriates), - `02`: Travel & Tourism - `03`: Education - `04`: Hospitalization & Medical Treatment, - `05`: Emergency Need - `06`: Savings - `07`: Gifts - `08`: Other - `09`: Salary - `10`: Crowd lending - `11`: Crypto currency - `12`: Refund to original card - `13`: Refund to new card - * @return $this - */ - public function setPurposeOfPayment($purposeOfPayment) - { - $this->container['purposeOfPayment'] = $purposeOfPayment; - - return $this; - } - - /** - * Gets reconciliationId - * @return string - */ - public function getReconciliationId() - { - return $this->container['reconciliationId']; - } - - /** - * Sets reconciliationId - * @param string $reconciliationId Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. For Payouts: max length for FDCCompass is String (22). - * @return $this - */ - public function setReconciliationId($reconciliationId) - { - $this->container['reconciliationId'] = $reconciliationId; - - return $this; - } - - /** - * Gets recurringOptions - * @return \CyberSource\Model\Ptsv1pushfundstransferProcessingInformationRecurringOptions - */ - public function getRecurringOptions() - { - return $this->container['recurringOptions']; - } - - /** - * Sets recurringOptions - * @param \CyberSource\Model\Ptsv1pushfundstransferProcessingInformationRecurringOptions $recurringOptions - * @return $this - */ - public function setRecurringOptions($recurringOptions) - { - $this->container['recurringOptions'] = $recurringOptions; - - return $this; - } - - /** - * Gets transactionReason - * @return string - */ - public function getTransactionReason() - { - return $this->container['transactionReason']; - } - - /** - * Sets transactionReason - * @param string $transactionReason Transaction reason code. This field applies only to Visa Platform Connect - * @return $this - */ - public function setTransactionReason($transactionReason) - { - $this->container['transactionReason'] = $transactionReason; - - return $this; - } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.php b/lib/Model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.php index ccad319ab..03f97d35d 100644 --- a/lib/Model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.php +++ b/lib/Model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.php @@ -53,8 +53,8 @@ class Ptsv1pushfundstransferProcessingInformationPayoutsOptions implements Array * @var string[] */ protected static $swaggerTypes = [ - 'accountFundingReferenceId' => 'string', - 'retrievalReferenceNumber' => 'string' + 'sourceCurrency' => 'string', + 'destinationCurrency' => 'string' ]; /** @@ -62,8 +62,8 @@ class Ptsv1pushfundstransferProcessingInformationPayoutsOptions implements Array * @var string[] */ protected static $swaggerFormats = [ - 'accountFundingReferenceId' => null, - 'retrievalReferenceNumber' => null + 'sourceCurrency' => null, + 'destinationCurrency' => null ]; public static function swaggerTypes() @@ -81,8 +81,8 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'accountFundingReferenceId' => 'accountFundingReferenceId', - 'retrievalReferenceNumber' => 'retrievalReferenceNumber' + 'sourceCurrency' => 'sourceCurrency', + 'destinationCurrency' => 'destinationCurrency' ]; @@ -91,8 +91,8 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'accountFundingReferenceId' => 'setAccountFundingReferenceId', - 'retrievalReferenceNumber' => 'setRetrievalReferenceNumber' + 'sourceCurrency' => 'setSourceCurrency', + 'destinationCurrency' => 'setDestinationCurrency' ]; @@ -101,8 +101,8 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'accountFundingReferenceId' => 'getAccountFundingReferenceId', - 'retrievalReferenceNumber' => 'getRetrievalReferenceNumber' + 'sourceCurrency' => 'getSourceCurrency', + 'destinationCurrency' => 'getDestinationCurrency' ]; public static function attributeMap() @@ -136,8 +136,8 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['accountFundingReferenceId'] = isset($data['accountFundingReferenceId']) ? $data['accountFundingReferenceId'] : null; - $this->container['retrievalReferenceNumber'] = isset($data['retrievalReferenceNumber']) ? $data['retrievalReferenceNumber'] : null; + $this->container['sourceCurrency'] = isset($data['sourceCurrency']) ? $data['sourceCurrency'] : null; + $this->container['destinationCurrency'] = isset($data['destinationCurrency']) ? $data['destinationCurrency'] : null; } /** @@ -166,43 +166,43 @@ public function valid() /** - * Gets accountFundingReferenceId + * Gets sourceCurrency * @return string */ - public function getAccountFundingReferenceId() + public function getSourceCurrency() { - return $this->container['accountFundingReferenceId']; + return $this->container['sourceCurrency']; } /** - * Sets accountFundingReferenceId - * @param string $accountFundingReferenceId Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request. Applicable only for Visa Platform Connect + * Sets sourceCurrency + * @param string $sourceCurrency Use a 3-character alpha currency code for source currency of the funds transfer. Yellow Pepper Supported for cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf * @return $this */ - public function setAccountFundingReferenceId($accountFundingReferenceId) + public function setSourceCurrency($sourceCurrency) { - $this->container['accountFundingReferenceId'] = $accountFundingReferenceId; + $this->container['sourceCurrency'] = $sourceCurrency; return $this; } /** - * Gets retrievalReferenceNumber + * Gets destinationCurrency * @return string */ - public function getRetrievalReferenceNumber() + public function getDestinationCurrency() { - return $this->container['retrievalReferenceNumber']; + return $this->container['destinationCurrency']; } /** - * Sets retrievalReferenceNumber - * @param string $retrievalReferenceNumber This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Format: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 – 366. Positions 5-12: A unique identification number generated by the merchant Applicable only for Visa Platform Connect + * Sets destinationCurrency + * @param string $destinationCurrency Use a 3-character alpha currency code for destination currency of the funds transfer. Yellow Pepper Supported for cross border funds transfers. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf * @return $this */ - public function setRetrievalReferenceNumber($retrievalReferenceNumber) + public function setDestinationCurrency($destinationCurrency) { - $this->container['retrievalReferenceNumber'] = $retrievalReferenceNumber; + $this->container['destinationCurrency'] = $destinationCurrency; return $this; } diff --git a/lib/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.php b/lib/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.php deleted file mode 100644 index 059bb8f21..000000000 --- a/lib/Model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.php +++ /dev/null @@ -1,245 +0,0 @@ - 'bool' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'loanPayment' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'loanPayment' => 'loanPayment' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'loanPayment' => 'setLoanPayment' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'loanPayment' => 'getLoanPayment' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['loanPayment'] = isset($data['loanPayment']) ? $data['loanPayment'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets loanPayment - * @return bool - */ - public function getLoanPayment() - { - return $this->container['loanPayment']; - } - - /** - * Sets loanPayment - * @param bool $loanPayment boolean Default: false Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: true: Loan payment false: (default) Not a loan payment This field applies only to FDC Compass - * @return $this - */ - public function setLoanPayment($loanPayment) - { - $this->container['loanPayment'] = $loanPayment; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferProcessingOptions.php b/lib/Model/Ptsv1pushfundstransferProcessingOptions.php deleted file mode 100644 index 3f6a21ade..000000000 --- a/lib/Model/Ptsv1pushfundstransferProcessingOptions.php +++ /dev/null @@ -1,245 +0,0 @@ - '\CyberSource\Model\Ptsv1pushfundstransferProcessingOptionsFundingOptions' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'fundingOptions' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'fundingOptions' => 'fundingOptions' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'fundingOptions' => 'setFundingOptions' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'fundingOptions' => 'getFundingOptions' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['fundingOptions'] = isset($data['fundingOptions']) ? $data['fundingOptions'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets fundingOptions - * @return \CyberSource\Model\Ptsv1pushfundstransferProcessingOptionsFundingOptions - */ - public function getFundingOptions() - { - return $this->container['fundingOptions']; - } - - /** - * Sets fundingOptions - * @param \CyberSource\Model\Ptsv1pushfundstransferProcessingOptionsFundingOptions $fundingOptions - * @return $this - */ - public function setFundingOptions($fundingOptions) - { - $this->container['fundingOptions'] = $fundingOptions; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.php b/lib/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.php deleted file mode 100644 index 2c7249082..000000000 --- a/lib/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.php +++ /dev/null @@ -1,245 +0,0 @@ - '\CyberSource\Model\Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'initiator' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'initiator' => 'initiator' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'initiator' => 'setInitiator' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'initiator' => 'getInitiator' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['initiator'] = isset($data['initiator']) ? $data['initiator'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets initiator - * @return \CyberSource\Model\Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator - */ - public function getInitiator() - { - return $this->container['initiator']; - } - - /** - * Sets initiator - * @param \CyberSource\Model\Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator $initiator - * @return $this - */ - public function setInitiator($initiator) - { - $this->container['initiator'] = $initiator; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.php b/lib/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.php deleted file mode 100644 index 843f52a9d..000000000 --- a/lib/Model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.php +++ /dev/null @@ -1,245 +0,0 @@ - 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'type' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'type' => 'type' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'type' => 'setType' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'type' => 'getType' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['type'] = isset($data['type']) ? $data['type'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets type - * @return string - */ - public function getType() - { - return $this->container['type']; - } - - /** - * Sets type - * @param string $type Visa Platform Connect : This API will contain a code that denotes whether the customer identification data belongs to the sender or the recipient. The valid values are: - `S` (Payer (sender)) - `R` (Payee (recipient)) This field applies only to Visa Platform Connect - * @return $this - */ - public function setType($type) - { - $this->container['type'] = $type; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Ptsv1pushfundstransferRecipientInformation.php b/lib/Model/Ptsv1pushfundstransferRecipientInformation.php index e83eab528..39fa83f21 100644 --- a/lib/Model/Ptsv1pushfundstransferRecipientInformation.php +++ b/lib/Model/Ptsv1pushfundstransferRecipientInformation.php @@ -62,9 +62,7 @@ class Ptsv1pushfundstransferRecipientInformation implements ArrayAccess 'country' => 'string', 'firstName' => 'string', 'middleName' => 'string', - 'middleInitial' => 'string', 'lastName' => 'string', - 'dateOfBirth' => 'string', 'phoneNumber' => 'string', 'personalIdentification' => '\CyberSource\Model\Ptsv1pushfundstransferRecipientInformationPersonalIdentification' ]; @@ -83,9 +81,7 @@ class Ptsv1pushfundstransferRecipientInformation implements ArrayAccess 'country' => null, 'firstName' => null, 'middleName' => null, - 'middleInitial' => null, 'lastName' => null, - 'dateOfBirth' => null, 'phoneNumber' => null, 'personalIdentification' => null ]; @@ -114,9 +110,7 @@ public static function swaggerFormats() 'country' => 'country', 'firstName' => 'firstName', 'middleName' => 'middleName', - 'middleInitial' => 'middleInitial', 'lastName' => 'lastName', - 'dateOfBirth' => 'dateOfBirth', 'phoneNumber' => 'phoneNumber', 'personalIdentification' => 'personalIdentification' ]; @@ -136,9 +130,7 @@ public static function swaggerFormats() 'country' => 'setCountry', 'firstName' => 'setFirstName', 'middleName' => 'setMiddleName', - 'middleInitial' => 'setMiddleInitial', 'lastName' => 'setLastName', - 'dateOfBirth' => 'setDateOfBirth', 'phoneNumber' => 'setPhoneNumber', 'personalIdentification' => 'setPersonalIdentification' ]; @@ -158,9 +150,7 @@ public static function swaggerFormats() 'country' => 'getCountry', 'firstName' => 'getFirstName', 'middleName' => 'getMiddleName', - 'middleInitial' => 'getMiddleInitial', 'lastName' => 'getLastName', - 'dateOfBirth' => 'getDateOfBirth', 'phoneNumber' => 'getPhoneNumber', 'personalIdentification' => 'getPersonalIdentification' ]; @@ -205,9 +195,7 @@ public function __construct(array $data = null) $this->container['country'] = isset($data['country']) ? $data['country'] : null; $this->container['firstName'] = isset($data['firstName']) ? $data['firstName'] : null; $this->container['middleName'] = isset($data['middleName']) ? $data['middleName'] : null; - $this->container['middleInitial'] = isset($data['middleInitial']) ? $data['middleInitial'] : null; $this->container['lastName'] = isset($data['lastName']) ? $data['lastName'] : null; - $this->container['dateOfBirth'] = isset($data['dateOfBirth']) ? $data['dateOfBirth'] : null; $this->container['phoneNumber'] = isset($data['phoneNumber']) ? $data['phoneNumber'] : null; $this->container['personalIdentification'] = isset($data['personalIdentification']) ? $data['personalIdentification'] : null; } @@ -269,7 +257,7 @@ public function getAddress1() /** * Sets address1 - * @param string $address1 First line of the recipient's address. Required for Mastercard Send. This field is not supported for Visa Platform Connect. + * @param string $address1 First line of the recipient's address. Required for card payments * @return $this */ public function setAddress1($address1) @@ -290,7 +278,7 @@ public function getAddress2() /** * Sets address2 - * @param string $address2 Second line of the recipient's address Optional for Mastercard Send. This field is not supported for Visa Platform Connect. + * @param string $address2 Second line of the recipient's address * @return $this */ public function setAddress2($address2) @@ -311,7 +299,7 @@ public function getLocality() /** * Sets locality - * @param string $locality Recipient city. Required for Mastercard Send. + * @param string $locality Recipient city. * @return $this */ public function setLocality($locality) @@ -332,7 +320,7 @@ public function getPostalCode() /** * Sets postalCode - * @param string $postalCode Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Mastercard Send: Required for recipients in Canada and Canadian issued cards. + * @param string $postalCode Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10. Mandatory for card payments. * @return $this */ public function setPostalCode($postalCode) @@ -353,7 +341,7 @@ public function getAdministrativeArea() /** * Sets administrativeArea - * @param string $administrativeArea The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. Required only for FDCCompass. This field is not supported for Visa Platform Connect. + * @param string $administrativeArea The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Required for card payments. * @return $this */ public function setAdministrativeArea($administrativeArea) @@ -374,7 +362,7 @@ public function getCountry() /** * Sets country - * @param string $country Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Required for Mastercard Send. + * @param string $country Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf * @return $this */ public function setCountry($country) @@ -395,7 +383,7 @@ public function getFirstName() /** * Sets firstName - * @param string $firstName First name of recipient. Visa Platform Connect (14) Chase Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. + * @param string $firstName First name of recipient. * @return $this */ public function setFirstName($firstName) @@ -426,27 +414,6 @@ public function setMiddleName($middleName) return $this; } - /** - * Gets middleInitial - * @return string - */ - public function getMiddleInitial() - { - return $this->container['middleInitial']; - } - - /** - * Sets middleInitial - * @param string $middleInitial Middle Initial of recipient. This field is supported by FDC Compass. - * @return $this - */ - public function setMiddleInitial($middleInitial) - { - $this->container['middleInitial'] = $middleInitial; - - return $this; - } - /** * Gets lastName * @return string @@ -458,7 +425,7 @@ public function getLastName() /** * Sets lastName - * @param string $lastName Last name of recipient. Visa Platform Connect (14) Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. + * @param string $lastName Last name of recipient. * @return $this */ public function setLastName($lastName) @@ -468,27 +435,6 @@ public function setLastName($lastName) return $this; } - /** - * Gets dateOfBirth - * @return string - */ - public function getDateOfBirth() - { - return $this->container['dateOfBirth']; - } - - /** - * Sets dateOfBirth - * @param string $dateOfBirth Recipient date of birth in YYYYMMDD format. - * @return $this - */ - public function setDateOfBirth($dateOfBirth) - { - $this->container['dateOfBirth'] = $dateOfBirth; - - return $this; - } - /** * Gets phoneNumber * @return string diff --git a/lib/Model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.php b/lib/Model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.php index 3cade76dd..1ebe6ef77 100644 --- a/lib/Model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.php +++ b/lib/Model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.php @@ -212,7 +212,7 @@ public function getType() /** * Sets type - * @param string $type Three-digit value that indicates the card type. Mandatory if not present in a token. Possible values: Visa Platform Connect - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `033`: Visa Electron - `024`: Maestro Mastercard Send: - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. FDC Compass: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Chase Paymentech: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. + * @param string $type Three-digit value that indicates the card type. Possible values: Visa Platform Connect - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `033`: Visa Electron - `024`: Maestro Mastercard Send: - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. FDC Compass: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Chase Paymentech: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. Yellow Pepper: - `001`: Visa - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `005`: Diners Club - `033`: Visa Electron - `024`: Intl Maestro * @return $this */ public function setType($type) diff --git a/lib/Model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.php b/lib/Model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.php index 593c23651..7a371e229 100644 --- a/lib/Model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.php +++ b/lib/Model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.php @@ -54,7 +54,8 @@ class Ptsv1pushfundstransferRecipientInformationPersonalIdentification implement */ protected static $swaggerTypes = [ 'id' => 'string', - 'type' => 'string' + 'type' => 'string', + 'issuingCountry' => 'string' ]; /** @@ -63,7 +64,8 @@ class Ptsv1pushfundstransferRecipientInformationPersonalIdentification implement */ protected static $swaggerFormats = [ 'id' => null, - 'type' => null + 'type' => null, + 'issuingCountry' => null ]; public static function swaggerTypes() @@ -82,7 +84,8 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'id' => 'id', - 'type' => 'type' + 'type' => 'type', + 'issuingCountry' => 'issuingCountry' ]; @@ -92,7 +95,8 @@ public static function swaggerFormats() */ protected static $setters = [ 'id' => 'setId', - 'type' => 'setType' + 'type' => 'setType', + 'issuingCountry' => 'setIssuingCountry' ]; @@ -102,7 +106,8 @@ public static function swaggerFormats() */ protected static $getters = [ 'id' => 'getId', - 'type' => 'getType' + 'type' => 'getType', + 'issuingCountry' => 'getIssuingCountry' ]; public static function attributeMap() @@ -138,6 +143,7 @@ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; + $this->container['issuingCountry'] = isset($data['issuingCountry']) ? $data['issuingCountry'] : null; } /** @@ -176,7 +182,7 @@ public function getId() /** * Sets id - * @param string $id The ID number/value. 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. Mastercard Send(80) + * @param string $id The ID number/value. Processor(35) * @return $this */ public function setId($id) @@ -197,7 +203,7 @@ public function getType() /** * Sets type - * @param string $type This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `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) Mastercard Send: - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `EIDN`: (Employer Identification Number) - `IDNB`: (Identity Card Number) + * @param string $type This tag will contain the type of sender identification. * @return $this */ public function setType($type) @@ -206,6 +212,27 @@ public function setType($type) return $this; } + + /** + * Gets issuingCountry + * @return string + */ + public function getIssuingCountry() + { + return $this->container['issuingCountry']; + } + + /** + * Sets issuingCountry + * @param string $issuingCountry Issuing country of the identification. The field format should be a 2 character ISO 3166-1 alpha-2 country code. + * @return $this + */ + public function setIssuingCountry($issuingCountry) + { + $this->container['issuingCountry'] = $issuingCountry; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Ptsv1pushfundstransferSenderInformation.php b/lib/Model/Ptsv1pushfundstransferSenderInformation.php index 68cdba6e3..627dca219 100644 --- a/lib/Model/Ptsv1pushfundstransferSenderInformation.php +++ b/lib/Model/Ptsv1pushfundstransferSenderInformation.php @@ -63,7 +63,6 @@ class Ptsv1pushfundstransferSenderInformation implements ArrayAccess 'locality' => 'string', 'administrativeArea' => 'string', 'country' => 'string', - 'vatRegistrationNumber' => 'string', 'dateOfBirth' => 'string', 'phoneNumber' => 'string', 'paymentInformation' => '\CyberSource\Model\Ptsv1pushfundstransferSenderInformationPaymentInformation', @@ -87,7 +86,6 @@ class Ptsv1pushfundstransferSenderInformation implements ArrayAccess 'locality' => null, 'administrativeArea' => null, 'country' => null, - 'vatRegistrationNumber' => null, 'dateOfBirth' => null, 'phoneNumber' => null, 'paymentInformation' => null, @@ -121,7 +119,6 @@ public static function swaggerFormats() 'locality' => 'locality', 'administrativeArea' => 'administrativeArea', 'country' => 'country', - 'vatRegistrationNumber' => 'vatRegistrationNumber', 'dateOfBirth' => 'dateOfBirth', 'phoneNumber' => 'phoneNumber', 'paymentInformation' => 'paymentInformation', @@ -146,7 +143,6 @@ public static function swaggerFormats() 'locality' => 'setLocality', 'administrativeArea' => 'setAdministrativeArea', 'country' => 'setCountry', - 'vatRegistrationNumber' => 'setVatRegistrationNumber', 'dateOfBirth' => 'setDateOfBirth', 'phoneNumber' => 'setPhoneNumber', 'paymentInformation' => 'setPaymentInformation', @@ -171,7 +167,6 @@ public static function swaggerFormats() 'locality' => 'getLocality', 'administrativeArea' => 'getAdministrativeArea', 'country' => 'getCountry', - 'vatRegistrationNumber' => 'getVatRegistrationNumber', 'dateOfBirth' => 'getDateOfBirth', 'phoneNumber' => 'getPhoneNumber', 'paymentInformation' => 'getPaymentInformation', @@ -221,7 +216,6 @@ public function __construct(array $data = null) $this->container['locality'] = isset($data['locality']) ? $data['locality'] : null; $this->container['administrativeArea'] = isset($data['administrativeArea']) ? $data['administrativeArea'] : null; $this->container['country'] = isset($data['country']) ? $data['country'] : null; - $this->container['vatRegistrationNumber'] = isset($data['vatRegistrationNumber']) ? $data['vatRegistrationNumber'] : null; $this->container['dateOfBirth'] = isset($data['dateOfBirth']) ? $data['dateOfBirth'] : null; $this->container['phoneNumber'] = isset($data['phoneNumber']) ? $data['phoneNumber'] : null; $this->container['paymentInformation'] = isset($data['paymentInformation']) ? $data['paymentInformation'] : null; @@ -287,7 +281,7 @@ public function getFirstName() /** * Sets firstName - * @param string $firstName This field contains the first name of the entity funding the transaction. + * @param string $firstName This field contains the first name of the entity funding the transaction Mandatory for card payments * @return $this */ public function setFirstName($firstName) @@ -308,7 +302,7 @@ public function getLastName() /** * Sets lastName - * @param string $lastName This field contains the last name of the entity funding the transaction. + * @param string $lastName This field contains the last name of the entity funding the transaction Mandatory for card payments * @return $this */ public function setLastName($lastName) @@ -329,7 +323,7 @@ public function getMiddleName() /** * Sets middleName - * @param string $middleName Supported only for Mastercard transactions. This field contains the middle name of the entity funding the transaction + * @param string $middleName This field contains the middle name of the entity funding the transaction * @return $this */ public function setMiddleName($middleName) @@ -371,7 +365,7 @@ public function getAddress1() /** * Sets address1 - * @param string $address1 Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. + * @param string $address1 Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Required for card transactions * @return $this */ public function setAddress1($address1) @@ -392,7 +386,7 @@ public function getAddress2() /** * Sets address2 - * @param string $address2 Used for additional address information. For example: Attention: Accounts Payable Optional field. This field is supported for only Mastercard Send. + * @param string $address2 Used for additional address information. For example: Attention: Accounts Payable Optional field. * @return $this */ public function setAddress2($address2) @@ -413,7 +407,7 @@ public function getLocality() /** * Sets locality - * @param string $locality The sender's city Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. + * @param string $locality The sender's city Mandatory for card payments * @return $this */ public function setLocality($locality) @@ -434,7 +428,7 @@ public function getAdministrativeArea() /** * Sets administrativeArea - * @param string $administrativeArea Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf + * @param string $administrativeArea Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Mandatory for card payments * @return $this */ public function setAdministrativeArea($administrativeArea) @@ -455,7 +449,7 @@ public function getCountry() /** * Sets country - * @param string $country Sender's country code. Use ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect Required for transactions using business application id of AA, BI, PP, and WT. Required for Mastercard Send + * @param string $country Sender's country code. Use ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf * @return $this */ public function setCountry($country) @@ -465,27 +459,6 @@ public function setCountry($country) return $this; } - /** - * Gets vatRegistrationNumber - * @return string - */ - public function getVatRegistrationNumber() - { - return $this->container['vatRegistrationNumber']; - } - - /** - * Sets vatRegistrationNumber - * @param string $vatRegistrationNumber Customer's government-assigned tax identification number. - * @return $this - */ - public function setVatRegistrationNumber($vatRegistrationNumber) - { - $this->container['vatRegistrationNumber'] = $vatRegistrationNumber; - - return $this; - } - /** * Gets dateOfBirth * @return string diff --git a/lib/Model/Ptsv1pushfundstransferSenderInformationAccount.php b/lib/Model/Ptsv1pushfundstransferSenderInformationAccount.php index 6a63f7117..bc2db612a 100644 --- a/lib/Model/Ptsv1pushfundstransferSenderInformationAccount.php +++ b/lib/Model/Ptsv1pushfundstransferSenderInformationAccount.php @@ -197,7 +197,7 @@ public function getNumber() /** * Sets number - * @param string $number The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. Funds disbursements This field is optional. All other transactions This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: FDC Compass (<= 19) Chase Paymentech (<= 16) + * @param string $number The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. Funds disbursements This field is optional. All other transactions This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: * @return $this */ public function setNumber($number) diff --git a/lib/Model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.php b/lib/Model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.php index c877820d2..fd6a3cb7e 100644 --- a/lib/Model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.php +++ b/lib/Model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.php @@ -221,7 +221,7 @@ public function getSecurityCode() /** * Sets securityCode - * @param string $securityCode 3-digit value that indicates the card Cvv2Value. Values can be 0-9. This field is supported in Mastercard Send. + * @param string $securityCode 3-digit value that indicates the card Cvv2Value. Values can be 0-9. * @return $this */ public function setSecurityCode($securityCode) @@ -242,7 +242,7 @@ public function getSourceAccountType() /** * Sets sourceAccountType - * @param string $sourceAccountType Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Valid values for Visa Platform Connect: - `CHECKING`: Checking account - `CREDIT`: Credit card account - `SAVING`: Saving account - `LINE_OF_CREDIT`: Line of credit or credit portion of combo card - `PREPAID`: Prepaid card account or prepaid portion of combo card - `UNIVERSAL`: Universal account Valid values for Mastercard Send: - `00`: Other, - `01`: RTN + Bank Account, - `02`: IBAN, - `03`: Card Account, - `04`: Email, - `05`: Phone Number, - `06`: Bank account number (BAN) + Bank Identification Сode (BIC), - `07`: Wallet ID, - `08`: Social Network ID. Numeric, 2 characters. This field is supported in Mastercard Send. + * @param string $sourceAccountType Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. * @return $this */ public function setSourceAccountType($sourceAccountType) @@ -263,7 +263,7 @@ public function getNumber() /** * Sets number - * @param string $number The customer's payment card number, also known as the Primary Account Number (PAN). This field is supported in Mastercard Send. + * @param string $number The customer's payment card number, also known as the Primary Account Number (PAN). * @return $this */ public function setNumber($number) @@ -284,7 +284,7 @@ public function getExpirationMonth() /** * Sets expirationMonth - * @param string $expirationMonth Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. This field is supported for Mastercard Send. + * @param string $expirationMonth Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required. * @return $this */ public function setExpirationMonth($expirationMonth) @@ -305,7 +305,7 @@ public function getExpirationYear() /** * Sets expirationYear - * @param string $expirationYear Four-digit year in which the payment card expires. This field is supported for Mastercard Send. + * @param string $expirationYear Four-digit year in which the payment card expires. * @return $this */ public function setExpirationYear($expirationYear) diff --git a/lib/Model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.php b/lib/Model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.php index 98ad5eba7..f603c2db2 100644 --- a/lib/Model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.php +++ b/lib/Model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.php @@ -55,7 +55,8 @@ class Ptsv1pushfundstransferSenderInformationPersonalIdentification implements A protected static $swaggerTypes = [ 'id' => 'string', 'personalIdType' => 'string', - 'type' => 'string' + 'type' => 'string', + 'issuingCountry' => 'string' ]; /** @@ -65,7 +66,8 @@ class Ptsv1pushfundstransferSenderInformationPersonalIdentification implements A protected static $swaggerFormats = [ 'id' => null, 'personalIdType' => null, - 'type' => null + 'type' => null, + 'issuingCountry' => null ]; public static function swaggerTypes() @@ -85,7 +87,8 @@ public static function swaggerFormats() protected static $attributeMap = [ 'id' => 'id', 'personalIdType' => 'personalIdType', - 'type' => 'type' + 'type' => 'type', + 'issuingCountry' => 'issuingCountry' ]; @@ -96,7 +99,8 @@ public static function swaggerFormats() protected static $setters = [ 'id' => 'setId', 'personalIdType' => 'setPersonalIdType', - 'type' => 'setType' + 'type' => 'setType', + 'issuingCountry' => 'setIssuingCountry' ]; @@ -107,7 +111,8 @@ public static function swaggerFormats() protected static $getters = [ 'id' => 'getId', 'personalIdType' => 'getPersonalIdType', - 'type' => 'getType' + 'type' => 'getType', + 'issuingCountry' => 'getIssuingCountry' ]; public static function attributeMap() @@ -144,6 +149,7 @@ public function __construct(array $data = null) $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['personalIdType'] = isset($data['personalIdType']) ? $data['personalIdType'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; + $this->container['issuingCountry'] = isset($data['issuingCountry']) ? $data['issuingCountry'] : null; } /** @@ -182,7 +188,7 @@ public function getId() /** * Sets id - * @param string $id Visa Platform Connect(35) This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender. Mastercard Send(80) + * @param string $id Processor(35) * @return $this */ public function setId($id) @@ -224,7 +230,7 @@ public function getType() /** * Sets type - * @param string $type This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `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) Mastercard Send: - `CUID`: (Customer identification (unspecified)) - `NTID`: (National identification) - `PASN`: (Passport number) - `DRLN`: (Driver license) - `TXIN`: (Tax identification) - `SSNB`: (Social security number) - `ARNB`: (Alien registration number) - `EIDN`: (Employer Identification Number) - `IDNB`: (Identity Card Number) + * @param string $type This tag will contain the type of sender identification. The valid values are: Visa Platform Connect: - `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) * @return $this */ public function setType($type) @@ -233,6 +239,27 @@ public function setType($type) return $this; } + + /** + * Gets issuingCountry + * @return string + */ + public function getIssuingCountry() + { + return $this->container['issuingCountry']; + } + + /** + * Sets issuingCountry + * @param string $issuingCountry Issuing country of the identification. The field format should be a 2 character ISO 3166-1 alpha-2 country code. + * @return $this + */ + public function setIssuingCountry($issuingCountry) + { + $this->container['issuingCountry'] = $issuingCountry; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Ptsv2billingagreementsAggregatorInformation.php b/lib/Model/Ptsv2billingagreementsAggregatorInformation.php index 2a19cf54e..6aba35f56 100644 --- a/lib/Model/Ptsv2billingagreementsAggregatorInformation.php +++ b/lib/Model/Ptsv2billingagreementsAggregatorInformation.php @@ -176,7 +176,7 @@ public function getName() /** * Sets name - * @param string $name Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $name Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### 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. * @return $this */ public function setName($name) diff --git a/lib/Model/Ptsv2billingagreementsBuyerInformation.php b/lib/Model/Ptsv2billingagreementsBuyerInformation.php index 32dbc640c..4a2c2eb03 100644 --- a/lib/Model/Ptsv2billingagreementsBuyerInformation.php +++ b/lib/Model/Ptsv2billingagreementsBuyerInformation.php @@ -209,7 +209,7 @@ public function getDateOfBirth() /** * Sets dateOfBirth - * @param string $dateOfBirth Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $dateOfBirth 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. * @return $this */ public function setDateOfBirth($dateOfBirth) diff --git a/lib/Model/Ptsv2billingagreementsClientReferenceInformation.php b/lib/Model/Ptsv2billingagreementsClientReferenceInformation.php index 75637ae47..17cfb10c6 100644 --- a/lib/Model/Ptsv2billingagreementsClientReferenceInformation.php +++ b/lib/Model/Ptsv2billingagreementsClientReferenceInformation.php @@ -302,7 +302,7 @@ public function getComments() /** * Sets comments - * @param string $comments Comments + * @param string $comments Brief description of the order or any comment you wish to add to the order. * @return $this */ public function setComments($comments) diff --git a/lib/Model/Ptsv2billingagreementsOrderInformationBillTo.php b/lib/Model/Ptsv2billingagreementsOrderInformationBillTo.php index 3018611c4..088590057 100644 --- a/lib/Model/Ptsv2billingagreementsOrderInformationBillTo.php +++ b/lib/Model/Ptsv2billingagreementsOrderInformationBillTo.php @@ -428,7 +428,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/Ptsv2billingagreementsidBuyerInformation.php b/lib/Model/Ptsv2billingagreementsidBuyerInformation.php index 23563758d..45afeba17 100644 --- a/lib/Model/Ptsv2billingagreementsidBuyerInformation.php +++ b/lib/Model/Ptsv2billingagreementsidBuyerInformation.php @@ -182,7 +182,7 @@ public function getDateOfBirth() /** * Sets dateOfBirth - * @param string $dateOfBirth Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $dateOfBirth 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. * @return $this */ public function setDateOfBirth($dateOfBirth) diff --git a/lib/Model/Ptsv2creditsProcessingInformation.php b/lib/Model/Ptsv2creditsProcessingInformation.php index 5b1f6c24f..f596c7aa7 100644 --- a/lib/Model/Ptsv2creditsProcessingInformation.php +++ b/lib/Model/Ptsv2creditsProcessingInformation.php @@ -278,7 +278,7 @@ public function getCommerceIndicator() /** * Sets commerceIndicator - * @param string $commerceIndicator Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * @param string $commerceIndicator Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" * @return $this */ public function setCommerceIndicator($commerceIndicator) @@ -362,7 +362,7 @@ public function getLinkId() /** * Sets linkId - * @param string $linkId Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $linkId Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @return $this */ public function setLinkId($linkId) @@ -383,7 +383,7 @@ public function getReportGroup() /** * Sets reportGroup - * @param string $reportGroup Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $reportGroup Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @return $this */ public function setReportGroup($reportGroup) diff --git a/lib/Model/Ptsv2creditsProcessingInformationBankTransferOptions.php b/lib/Model/Ptsv2creditsProcessingInformationBankTransferOptions.php index 562ecb603..8b27df001 100644 --- a/lib/Model/Ptsv2creditsProcessingInformationBankTransferOptions.php +++ b/lib/Model/Ptsv2creditsProcessingInformationBankTransferOptions.php @@ -227,7 +227,7 @@ public function getSecCode() /** * Sets secCode - * @param string $secCode Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $secCode Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry * @return $this */ public function setSecCode($secCode) @@ -311,7 +311,7 @@ public function getPartialPaymentId() /** * Sets partialPaymentId - * @param string $partialPaymentId Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $partialPaymentId Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. * @return $this */ public function setPartialPaymentId($partialPaymentId) @@ -332,7 +332,7 @@ public function getSettlementMethod() /** * Sets settlementMethod - * @param string $settlementMethod Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $settlementMethod Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) * @return $this */ public function setSettlementMethod($settlementMethod) diff --git a/lib/Model/Ptsv2paymentreferencesBuyerInformation.php b/lib/Model/Ptsv2paymentreferencesBuyerInformation.php index 309f7d1b5..2095418e2 100644 --- a/lib/Model/Ptsv2paymentreferencesBuyerInformation.php +++ b/lib/Model/Ptsv2paymentreferencesBuyerInformation.php @@ -194,7 +194,7 @@ public function getDateOfBirth() /** * Sets dateOfBirth - * @param string $dateOfBirth Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $dateOfBirth 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. * @return $this */ public function setDateOfBirth($dateOfBirth) diff --git a/lib/Model/Ptsv2paymentreferencesOrderInformationAmountDetails.php b/lib/Model/Ptsv2paymentreferencesOrderInformationAmountDetails.php index 696be5766..0af954755 100644 --- a/lib/Model/Ptsv2paymentreferencesOrderInformationAmountDetails.php +++ b/lib/Model/Ptsv2paymentreferencesOrderInformationAmountDetails.php @@ -242,7 +242,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -263,7 +263,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) @@ -347,7 +347,7 @@ public function getExchangeRate() /** * Sets exchangeRate - * @param string $exchangeRate Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [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) + * @param string $exchangeRate Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. * @return $this */ public function setExchangeRate($exchangeRate) diff --git a/lib/Model/Ptsv2paymentreferencesPaymentInformationBank.php b/lib/Model/Ptsv2paymentreferencesPaymentInformationBank.php index f0d59273a..e9b9af40e 100644 --- a/lib/Model/Ptsv2paymentreferencesPaymentInformationBank.php +++ b/lib/Model/Ptsv2paymentreferencesPaymentInformationBank.php @@ -176,7 +176,7 @@ public function getSwiftCode() /** * Sets swiftCode - * @param string $swiftCode Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $swiftCode Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. * @return $this */ public function setSwiftCode($swiftCode) diff --git a/lib/Model/Ptsv2paymentreferencesPaymentInformationBankAccount.php b/lib/Model/Ptsv2paymentreferencesPaymentInformationBankAccount.php index 1e90634e7..044462af5 100644 --- a/lib/Model/Ptsv2paymentreferencesPaymentInformationBankAccount.php +++ b/lib/Model/Ptsv2paymentreferencesPaymentInformationBankAccount.php @@ -197,7 +197,7 @@ public function getIban() /** * Sets iban - * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @return $this */ public function setIban($iban) diff --git a/lib/Model/Ptsv2paymentsAggregatorInformation.php b/lib/Model/Ptsv2paymentsAggregatorInformation.php index c8131a23b..46b901bbc 100644 --- a/lib/Model/Ptsv2paymentsAggregatorInformation.php +++ b/lib/Model/Ptsv2paymentsAggregatorInformation.php @@ -182,7 +182,7 @@ public function getAggregatorId() /** * Sets aggregatorId - * @param string $aggregatorId 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. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $aggregatorId 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. * @return $this */ public function setAggregatorId($aggregatorId) @@ -203,7 +203,7 @@ public function getName() /** * Sets name - * @param string $name Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $name Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### 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. * @return $this */ public function setName($name) diff --git a/lib/Model/Ptsv2paymentsBuyerInformation.php b/lib/Model/Ptsv2paymentsBuyerInformation.php index 8ae95a9ef..aea90884a 100644 --- a/lib/Model/Ptsv2paymentsBuyerInformation.php +++ b/lib/Model/Ptsv2paymentsBuyerInformation.php @@ -230,7 +230,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @return $this */ public function setMerchantCustomerId($merchantCustomerId) @@ -251,7 +251,7 @@ public function getDateOfBirth() /** * Sets dateOfBirth - * @param string $dateOfBirth Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $dateOfBirth 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. * @return $this */ public function setDateOfBirth($dateOfBirth) @@ -272,7 +272,7 @@ public function getVatRegistrationNumber() /** * Sets vatRegistrationNumber - * @param string $vatRegistrationNumber Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * @param string $vatRegistrationNumber Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. * @return $this */ public function setVatRegistrationNumber($vatRegistrationNumber) @@ -335,7 +335,7 @@ public function getHashedPassword() /** * Sets hashedPassword - * @param string $hashedPassword The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $hashedPassword The merchant's password that CyberSource hashes and stores as a hashed password. * @return $this */ public function setHashedPassword($hashedPassword) diff --git a/lib/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.php b/lib/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.php index 995614fbe..e6a3c890f 100644 --- a/lib/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.php +++ b/lib/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.php @@ -188,7 +188,7 @@ public function getType() /** * Sets type - * @param string $type The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $type The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. * @return $this */ public function setType($type) @@ -209,7 +209,7 @@ public function getId() /** * Sets id - * @param string $id The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. + * @param string $id The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy. * @return $this */ public function setId($id) @@ -230,7 +230,7 @@ public function getIssuedBy() /** * Sets issuedBy - * @param string $issuedBy The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. For details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) For details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $issuedBy The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer's driver's license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. * @return $this */ public function setIssuedBy($issuedBy) diff --git a/lib/Model/Ptsv2paymentsClientReferenceInformation.php b/lib/Model/Ptsv2paymentsClientReferenceInformation.php index 1f75d4c6d..0bc9ebef1 100644 --- a/lib/Model/Ptsv2paymentsClientReferenceInformation.php +++ b/lib/Model/Ptsv2paymentsClientReferenceInformation.php @@ -302,7 +302,7 @@ public function getComments() /** * Sets comments - * @param string $comments Comments + * @param string $comments Brief description of the order or any comment you wish to add to the order. * @return $this */ public function setComments($comments) diff --git a/lib/Model/Ptsv2paymentsConsumerAuthenticationInformation.php b/lib/Model/Ptsv2paymentsConsumerAuthenticationInformation.php index 6437fd824..3bd65574e 100644 --- a/lib/Model/Ptsv2paymentsConsumerAuthenticationInformation.php +++ b/lib/Model/Ptsv2paymentsConsumerAuthenticationInformation.php @@ -569,7 +569,7 @@ public function getEciRaw() /** * Sets eciRaw - * @param string $eciRaw Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $eciRaw Raw electronic commerce indicator (ECI). * @return $this */ public function setEciRaw($eciRaw) @@ -590,7 +590,7 @@ public function getParesStatus() /** * Sets paresStatus - * @param string $paresStatus Payer authentication response status. For details, see `pares_status` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $paresStatus Payer authentication response status. * @return $this */ public function setParesStatus($paresStatus) @@ -611,7 +611,7 @@ public function getVeresEnrolled() /** * Sets veresEnrolled - * @param string $veresEnrolled Verification response enrollment status. For details, see `veres_enrolled` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $veresEnrolled Verification response enrollment status. * @return $this */ public function setVeresEnrolled($veresEnrolled) @@ -632,7 +632,7 @@ public function getXid() /** * Sets xid - * @param string $xid Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $xid Transaction identifier. * @return $this */ public function setXid($xid) @@ -653,7 +653,7 @@ public function getUcafCollectionIndicator() /** * Sets ucafCollectionIndicator - * @param string $ucafCollectionIndicator Universal cardholder authentication field (UCAF) collection indicator. For details, see `ucaf_collection_indicator` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator + * @param string $ucafCollectionIndicator Universal cardholder authentication field (UCAF) collection indicator. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator * @return $this */ public function setUcafCollectionIndicator($ucafCollectionIndicator) @@ -674,7 +674,7 @@ public function getUcafAuthenticationData() /** * Sets ucafAuthenticationData - * @param string $ucafAuthenticationData Universal cardholder authentication field (UCAF) data. For details, see `ucaf_authentication_data` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $ucafAuthenticationData Universal cardholder authentication field (UCAF) data. * @return $this */ public function setUcafAuthenticationData($ucafAuthenticationData) @@ -968,7 +968,7 @@ public function getChallengeCode() /** * Sets challengeCode - * @param string $challengeCode Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html) + * @param string $challengeCode Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. * @return $this */ public function setChallengeCode($challengeCode) diff --git a/lib/Model/Ptsv2paymentsMerchantDefinedInformation.php b/lib/Model/Ptsv2paymentsMerchantDefinedInformation.php index ef0304e2b..cdcda7b4a 100644 --- a/lib/Model/Ptsv2paymentsMerchantDefinedInformation.php +++ b/lib/Model/Ptsv2paymentsMerchantDefinedInformation.php @@ -176,7 +176,7 @@ public function getKey() /** * Sets key - * @param string $key The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $key The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. * @return $this */ public function setKey($key) @@ -197,7 +197,7 @@ public function getValue() /** * Sets value - * @param string $value The value you assign for your merchant-defined data field. For details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 + * @param string $value The value you assign for your merchant-defined data field. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 * @return $this */ public function setValue($value) diff --git a/lib/Model/Ptsv2paymentsOrderInformationAmountDetails.php b/lib/Model/Ptsv2paymentsOrderInformationAmountDetails.php index 14620da09..e060c8ef9 100644 --- a/lib/Model/Ptsv2paymentsOrderInformationAmountDetails.php +++ b/lib/Model/Ptsv2paymentsOrderInformationAmountDetails.php @@ -353,7 +353,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -395,7 +395,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) @@ -584,7 +584,7 @@ public function getFreightAmount() /** * Sets freightAmount - * @param string $freightAmount Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * @param string $freightAmount Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. * @return $this */ public function setFreightAmount($freightAmount) @@ -605,7 +605,7 @@ public function getForeignAmount() /** * Sets foreignAmount - * @param string $foreignAmount Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $foreignAmount Set this field to the converted amount that was returned by the DCC provider. * @return $this */ public function setForeignAmount($foreignAmount) @@ -647,7 +647,7 @@ public function getExchangeRate() /** * Sets exchangeRate - * @param string $exchangeRate Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [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) + * @param string $exchangeRate Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. * @return $this */ public function setExchangeRate($exchangeRate) diff --git a/lib/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.php b/lib/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.php index c84dc2014..3a5a0f278 100644 --- a/lib/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.php +++ b/lib/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.php @@ -176,7 +176,7 @@ public function getCode() /** * Sets code - * @param string $code Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the `additional_amount_type0` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $code Additional amount type. This field is supported only for **American Express Direct**. * @return $this */ public function setCode($code) diff --git a/lib/Model/Ptsv2paymentsOrderInformationBillTo.php b/lib/Model/Ptsv2paymentsOrderInformationBillTo.php index 156db62c1..810d81c2c 100644 --- a/lib/Model/Ptsv2paymentsOrderInformationBillTo.php +++ b/lib/Model/Ptsv2paymentsOrderInformationBillTo.php @@ -665,7 +665,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/Ptsv2paymentsOrderInformationBillToCompany.php b/lib/Model/Ptsv2paymentsOrderInformationBillToCompany.php index 3f5c38320..469988f55 100644 --- a/lib/Model/Ptsv2paymentsOrderInformationBillToCompany.php +++ b/lib/Model/Ptsv2paymentsOrderInformationBillToCompany.php @@ -206,7 +206,7 @@ public function getName() /** * Sets name - * @param string $name Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $name Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @return $this */ public function setName($name) diff --git a/lib/Model/Ptsv2paymentsPaymentInformationBank.php b/lib/Model/Ptsv2paymentsPaymentInformationBank.php index 03cfd6e2d..46ec12dcf 100644 --- a/lib/Model/Ptsv2paymentsPaymentInformationBank.php +++ b/lib/Model/Ptsv2paymentsPaymentInformationBank.php @@ -215,7 +215,7 @@ public function getRoutingNumber() /** * Sets routingNumber - * @param string $routingNumber Bank routing number. This is also called the _transit number_. For details, see `ecp_rdfi` request field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $routingNumber Bank routing number. This is also called the _transit number_. * @return $this */ public function setRoutingNumber($routingNumber) @@ -236,7 +236,7 @@ public function getIban() /** * Sets iban - * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @return $this */ public function setIban($iban) @@ -257,7 +257,7 @@ public function getSwiftCode() /** * Sets swiftCode - * @param string $swiftCode Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $swiftCode Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. * @return $this */ public function setSwiftCode($swiftCode) diff --git a/lib/Model/Ptsv2paymentsPaymentInformationBankAccount.php b/lib/Model/Ptsv2paymentsPaymentInformationBankAccount.php index 9593057ee..f250c6f1d 100644 --- a/lib/Model/Ptsv2paymentsPaymentInformationBankAccount.php +++ b/lib/Model/Ptsv2paymentsPaymentInformationBankAccount.php @@ -242,7 +242,7 @@ public function getEncoderId() /** * Sets encoderId - * @param string $encoderId Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $encoderId Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. * @return $this */ public function setEncoderId($encoderId) @@ -305,7 +305,7 @@ public function getIban() /** * Sets iban - * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @return $this */ public function setIban($iban) diff --git a/lib/Model/Ptsv2paymentsPaymentInformationCustomer.php b/lib/Model/Ptsv2paymentsPaymentInformationCustomer.php index d259ec69b..6e2a13363 100644 --- a/lib/Model/Ptsv2paymentsPaymentInformationCustomer.php +++ b/lib/Model/Ptsv2paymentsPaymentInformationCustomer.php @@ -176,7 +176,7 @@ public function getCustomerId() /** * Sets customerId - * @param string $customerId Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $customerId Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. * @return $this */ public function setCustomerId($customerId) diff --git a/lib/Model/Ptsv2paymentsProcessingInformation.php b/lib/Model/Ptsv2paymentsProcessingInformation.php index 56a347e4e..1e49027ab 100644 --- a/lib/Model/Ptsv2paymentsProcessingInformation.php +++ b/lib/Model/Ptsv2paymentsProcessingInformation.php @@ -512,7 +512,7 @@ public function getBusinessApplicationId() /** * Sets businessApplicationId - * @param string $businessApplicationId Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) + * @param string $businessApplicationId Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. * @return $this */ public function setBusinessApplicationId($businessApplicationId) @@ -533,7 +533,7 @@ public function getCommerceIndicator() /** * Sets commerceIndicator - * @param string $commerceIndicator Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * @param string $commerceIndicator Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" * @return $this */ public function setCommerceIndicator($commerceIndicator) @@ -554,7 +554,7 @@ public function getCommerceIndicatorLabel() /** * Sets commerceIndicatorLabel - * @param string $commerceIndicatorLabel Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * @param string $commerceIndicatorLabel Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` * @return $this */ public function setCommerceIndicatorLabel($commerceIndicatorLabel) @@ -617,7 +617,7 @@ public function getLinkId() /** * Sets linkId - * @param string $linkId Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $linkId Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @return $this */ public function setLinkId($linkId) @@ -722,7 +722,7 @@ public function getReportGroup() /** * Sets reportGroup - * @param string $reportGroup Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $reportGroup Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @return $this */ public function setReportGroup($reportGroup) diff --git a/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.php b/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.php index f8a50b699..619da6106 100644 --- a/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.php +++ b/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.php @@ -296,7 +296,7 @@ public function getAuthType() /** * Sets authType - * @param string $authType Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### 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 more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). + * @param string $authType 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. * @return $this */ public function setAuthType($authType) @@ -338,7 +338,7 @@ public function getVerbalAuthCode() /** * Sets verbalAuthCode - * @param string $verbalAuthCode Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). + * @param string $verbalAuthCode Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. * @return $this */ public function setVerbalAuthCode($verbalAuthCode) diff --git a/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.php b/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.php index 9937b2cfe..7bb1e4735 100644 --- a/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.php +++ b/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.php @@ -209,7 +209,7 @@ public function getCredentialStoredOnFile() /** * Sets credentialStoredOnFile - * @param bool $credentialStoredOnFile Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **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. + * @param bool $credentialStoredOnFile Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. * @return $this */ public function setCredentialStoredOnFile($credentialStoredOnFile) diff --git a/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.php b/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.php index b75b0c859..b7d7d998a 100644 --- a/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.php +++ b/lib/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.php @@ -182,7 +182,7 @@ public function getReason() /** * Sets reason - * @param string $reason Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $reason 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 * @return $this */ public function setReason($reason) @@ -224,7 +224,7 @@ public function getOriginalAuthorizedAmount() /** * Sets originalAuthorizedAmount - * @param string $originalAuthorizedAmount Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * @param string $originalAuthorizedAmount 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. * @return $this */ public function setOriginalAuthorizedAmount($originalAuthorizedAmount) diff --git a/lib/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.php b/lib/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.php index 038a713f1..6cb26d56d 100644 --- a/lib/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.php +++ b/lib/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.php @@ -251,7 +251,7 @@ public function getSecCode() /** * Sets secCode - * @param string $secCode Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $secCode Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry * @return $this */ public function setSecCode($secCode) @@ -335,7 +335,7 @@ public function getPartialPaymentId() /** * Sets partialPaymentId - * @param string $partialPaymentId Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $partialPaymentId Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. * @return $this */ public function setPartialPaymentId($partialPaymentId) @@ -377,7 +377,7 @@ public function getPaymentCategoryCode() /** * Sets paymentCategoryCode - * @param string $paymentCategoryCode Flag that indicates whether to process the payment. Use with deferred payments. For details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. + * @param string $paymentCategoryCode Flag that indicates whether to process the payment. Use with deferred payments. Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. * @return $this */ public function setPaymentCategoryCode($paymentCategoryCode) @@ -398,7 +398,7 @@ public function getSettlementMethod() /** * Sets settlementMethod - * @param string $settlementMethod Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + * @param string $settlementMethod Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) * @return $this */ public function setSettlementMethod($settlementMethod) @@ -419,7 +419,7 @@ public function getFraudScreeningLevel() /** * Sets fraudScreeningLevel - * @param string $fraudScreeningLevel Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/). + * @param string $fraudScreeningLevel Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification * @return $this */ public function setFraudScreeningLevel($fraudScreeningLevel) diff --git a/lib/Model/Ptsv2paymentsTokenInformation.php b/lib/Model/Ptsv2paymentsTokenInformation.php index 358a7a863..d4685ab8a 100644 --- a/lib/Model/Ptsv2paymentsTokenInformation.php +++ b/lib/Model/Ptsv2paymentsTokenInformation.php @@ -57,7 +57,8 @@ class Ptsv2paymentsTokenInformation implements ArrayAccess 'transientTokenJwt' => 'string', 'paymentInstrument' => '\CyberSource\Model\Ptsv2paymentsTokenInformationPaymentInstrument', 'shippingAddress' => '\CyberSource\Model\Ptsv2paymentsTokenInformationShippingAddress', - 'networkTokenOption' => 'string' + 'networkTokenOption' => 'string', + 'tokenProvisioningInformation' => '\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation' ]; /** @@ -69,7 +70,8 @@ class Ptsv2paymentsTokenInformation implements ArrayAccess 'transientTokenJwt' => null, 'paymentInstrument' => null, 'shippingAddress' => null, - 'networkTokenOption' => null + 'networkTokenOption' => null, + 'tokenProvisioningInformation' => null ]; public static function swaggerTypes() @@ -91,7 +93,8 @@ public static function swaggerFormats() 'transientTokenJwt' => 'transientTokenJwt', 'paymentInstrument' => 'paymentInstrument', 'shippingAddress' => 'shippingAddress', - 'networkTokenOption' => 'networkTokenOption' + 'networkTokenOption' => 'networkTokenOption', + 'tokenProvisioningInformation' => 'tokenProvisioningInformation' ]; @@ -104,7 +107,8 @@ public static function swaggerFormats() 'transientTokenJwt' => 'setTransientTokenJwt', 'paymentInstrument' => 'setPaymentInstrument', 'shippingAddress' => 'setShippingAddress', - 'networkTokenOption' => 'setNetworkTokenOption' + 'networkTokenOption' => 'setNetworkTokenOption', + 'tokenProvisioningInformation' => 'setTokenProvisioningInformation' ]; @@ -117,7 +121,8 @@ public static function swaggerFormats() 'transientTokenJwt' => 'getTransientTokenJwt', 'paymentInstrument' => 'getPaymentInstrument', 'shippingAddress' => 'getShippingAddress', - 'networkTokenOption' => 'getNetworkTokenOption' + 'networkTokenOption' => 'getNetworkTokenOption', + 'tokenProvisioningInformation' => 'getTokenProvisioningInformation' ]; public static function attributeMap() @@ -156,6 +161,7 @@ public function __construct(array $data = null) $this->container['paymentInstrument'] = isset($data['paymentInstrument']) ? $data['paymentInstrument'] : null; $this->container['shippingAddress'] = isset($data['shippingAddress']) ? $data['shippingAddress'] : null; $this->container['networkTokenOption'] = isset($data['networkTokenOption']) ? $data['networkTokenOption'] : null; + $this->container['tokenProvisioningInformation'] = isset($data['tokenProvisioningInformation']) ? $data['tokenProvisioningInformation'] : null; } /** @@ -287,6 +293,27 @@ public function setNetworkTokenOption($networkTokenOption) return $this; } + + /** + * Gets tokenProvisioningInformation + * @return \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation + */ + public function getTokenProvisioningInformation() + { + return $this->container['tokenProvisioningInformation']; + } + + /** + * Sets tokenProvisioningInformation + * @param \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation $tokenProvisioningInformation + * @return $this + */ + public function setTokenProvisioningInformation($tokenProvisioningInformation) + { + $this->container['tokenProvisioningInformation'] = $tokenProvisioningInformation; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.php b/lib/Model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.php similarity index 95% rename from lib/Model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.php rename to lib/Model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.php index 60c887c9e..93ce53057 100644 --- a/lib/Model/TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation.php +++ b/lib/Model/Ptsv2paymentsTokenInformationTokenProvisioningInformation.php @@ -1,6 +1,6 @@ **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @return $this */ public function setIban($iban) @@ -251,7 +251,7 @@ public function getSwiftCode() /** * Sets swiftCode - * @param string $swiftCode Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $swiftCode Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. * @return $this */ public function setSwiftCode($swiftCode) diff --git a/lib/Model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.php b/lib/Model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.php index dc37fa20c..1a6093640 100644 --- a/lib/Model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.php +++ b/lib/Model/Ptsv2paymentsidrefundsPaymentInformationBankAccount.php @@ -236,7 +236,7 @@ public function getEncoderId() /** * Sets encoderId - * @param string $encoderId Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $encoderId Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. * @return $this */ public function setEncoderId($encoderId) diff --git a/lib/Model/Ptsv2paymentsidrefundsProcessingInformation.php b/lib/Model/Ptsv2paymentsidrefundsProcessingInformation.php index 4f3811263..fb2e75ab0 100644 --- a/lib/Model/Ptsv2paymentsidrefundsProcessingInformation.php +++ b/lib/Model/Ptsv2paymentsidrefundsProcessingInformation.php @@ -293,7 +293,7 @@ public function getLinkId() /** * Sets linkId - * @param string $linkId Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $linkId Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @return $this */ public function setLinkId($linkId) @@ -314,7 +314,7 @@ public function getReportGroup() /** * Sets reportGroup - * @param string $reportGroup Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $reportGroup Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @return $this */ public function setReportGroup($reportGroup) diff --git a/lib/Model/Ptsv2paymentsidreversalsClientReferenceInformation.php b/lib/Model/Ptsv2paymentsidreversalsClientReferenceInformation.php index fdb21e70f..b53989d94 100644 --- a/lib/Model/Ptsv2paymentsidreversalsClientReferenceInformation.php +++ b/lib/Model/Ptsv2paymentsidreversalsClientReferenceInformation.php @@ -260,7 +260,7 @@ public function getComments() /** * Sets comments - * @param string $comments Comments + * @param string $comments Brief description of the order or any comment you wish to add to the order. * @return $this */ public function setComments($comments) diff --git a/lib/Model/Ptsv2paymentsidreversalsProcessingInformation.php b/lib/Model/Ptsv2paymentsidreversalsProcessingInformation.php index f489a663c..cc8bd15e2 100644 --- a/lib/Model/Ptsv2paymentsidreversalsProcessingInformation.php +++ b/lib/Model/Ptsv2paymentsidreversalsProcessingInformation.php @@ -248,7 +248,7 @@ public function getLinkId() /** * Sets linkId - * @param string $linkId Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $linkId Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments * @return $this */ public function setLinkId($linkId) @@ -269,7 +269,7 @@ public function getReportGroup() /** * Sets reportGroup - * @param string $reportGroup Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $reportGroup Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. * @return $this */ public function setReportGroup($reportGroup) diff --git a/lib/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.php b/lib/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.php index 619a1d08d..6165a9e2c 100644 --- a/lib/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.php +++ b/lib/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.php @@ -176,7 +176,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -197,7 +197,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/Ptsv2payoutsOrderInformationAmountDetails.php b/lib/Model/Ptsv2payoutsOrderInformationAmountDetails.php index 04f849ac7..518baa6ea 100644 --- a/lib/Model/Ptsv2payoutsOrderInformationAmountDetails.php +++ b/lib/Model/Ptsv2payoutsOrderInformationAmountDetails.php @@ -182,7 +182,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -203,7 +203,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/Ptsv2payoutsRecipientInformation.php b/lib/Model/Ptsv2payoutsRecipientInformation.php index 6ec398b9e..51788e1d3 100644 --- a/lib/Model/Ptsv2payoutsRecipientInformation.php +++ b/lib/Model/Ptsv2payoutsRecipientInformation.php @@ -54,7 +54,6 @@ class Ptsv2payoutsRecipientInformation implements ArrayAccess */ protected static $swaggerTypes = [ 'firstName' => 'string', - 'middleInitial' => 'string', 'middleName' => 'string', 'lastName' => 'string', 'address1' => 'string', @@ -62,8 +61,7 @@ class Ptsv2payoutsRecipientInformation implements ArrayAccess 'administrativeArea' => 'string', 'country' => 'string', 'postalCode' => 'string', - 'phoneNumber' => 'string', - 'dateOfBirth' => 'string' + 'phoneNumber' => 'string' ]; /** @@ -72,7 +70,6 @@ class Ptsv2payoutsRecipientInformation implements ArrayAccess */ protected static $swaggerFormats = [ 'firstName' => null, - 'middleInitial' => null, 'middleName' => null, 'lastName' => null, 'address1' => null, @@ -80,8 +77,7 @@ class Ptsv2payoutsRecipientInformation implements ArrayAccess 'administrativeArea' => null, 'country' => null, 'postalCode' => null, - 'phoneNumber' => null, - 'dateOfBirth' => null + 'phoneNumber' => null ]; public static function swaggerTypes() @@ -100,7 +96,6 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'firstName' => 'firstName', - 'middleInitial' => 'middleInitial', 'middleName' => 'middleName', 'lastName' => 'lastName', 'address1' => 'address1', @@ -108,8 +103,7 @@ public static function swaggerFormats() 'administrativeArea' => 'administrativeArea', 'country' => 'country', 'postalCode' => 'postalCode', - 'phoneNumber' => 'phoneNumber', - 'dateOfBirth' => 'dateOfBirth' + 'phoneNumber' => 'phoneNumber' ]; @@ -119,7 +113,6 @@ public static function swaggerFormats() */ protected static $setters = [ 'firstName' => 'setFirstName', - 'middleInitial' => 'setMiddleInitial', 'middleName' => 'setMiddleName', 'lastName' => 'setLastName', 'address1' => 'setAddress1', @@ -127,8 +120,7 @@ public static function swaggerFormats() 'administrativeArea' => 'setAdministrativeArea', 'country' => 'setCountry', 'postalCode' => 'setPostalCode', - 'phoneNumber' => 'setPhoneNumber', - 'dateOfBirth' => 'setDateOfBirth' + 'phoneNumber' => 'setPhoneNumber' ]; @@ -138,7 +130,6 @@ public static function swaggerFormats() */ protected static $getters = [ 'firstName' => 'getFirstName', - 'middleInitial' => 'getMiddleInitial', 'middleName' => 'getMiddleName', 'lastName' => 'getLastName', 'address1' => 'getAddress1', @@ -146,8 +137,7 @@ public static function swaggerFormats() 'administrativeArea' => 'getAdministrativeArea', 'country' => 'getCountry', 'postalCode' => 'getPostalCode', - 'phoneNumber' => 'getPhoneNumber', - 'dateOfBirth' => 'getDateOfBirth' + 'phoneNumber' => 'getPhoneNumber' ]; public static function attributeMap() @@ -182,7 +172,6 @@ public static function getters() public function __construct(array $data = null) { $this->container['firstName'] = isset($data['firstName']) ? $data['firstName'] : null; - $this->container['middleInitial'] = isset($data['middleInitial']) ? $data['middleInitial'] : null; $this->container['middleName'] = isset($data['middleName']) ? $data['middleName'] : null; $this->container['lastName'] = isset($data['lastName']) ? $data['lastName'] : null; $this->container['address1'] = isset($data['address1']) ? $data['address1'] : null; @@ -191,7 +180,6 @@ public function __construct(array $data = null) $this->container['country'] = isset($data['country']) ? $data['country'] : null; $this->container['postalCode'] = isset($data['postalCode']) ? $data['postalCode'] : null; $this->container['phoneNumber'] = isset($data['phoneNumber']) ? $data['phoneNumber'] : null; - $this->container['dateOfBirth'] = isset($data['dateOfBirth']) ? $data['dateOfBirth'] : null; } /** @@ -240,27 +228,6 @@ public function setFirstName($firstName) return $this; } - /** - * Gets middleInitial - * @return string - */ - public function getMiddleInitial() - { - return $this->container['middleInitial']; - } - - /** - * Sets middleInitial - * @param string $middleInitial Middle Initial of recipient. Required only for FDCCompass. - * @return $this - */ - public function setMiddleInitial($middleInitial) - { - $this->container['middleInitial'] = $middleInitial; - - return $this; - } - /** * Gets middleName * @return string @@ -428,27 +395,6 @@ public function setPhoneNumber($phoneNumber) return $this; } - - /** - * Gets dateOfBirth - * @return string - */ - public function getDateOfBirth() - { - return $this->container['dateOfBirth']; - } - - /** - * Sets dateOfBirth - * @param string $dateOfBirth Recipient date of birth in YYYYMMDD format. Required only for FDCCompass. - * @return $this - */ - public function setDateOfBirth($dateOfBirth) - { - $this->container['dateOfBirth'] = $dateOfBirth; - - return $this; - } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.php b/lib/Model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.php index 56fa61b53..92f6cc361 100644 --- a/lib/Model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.php +++ b/lib/Model/Ptsv2refreshpaymentstatusidPaymentInformationCustomer.php @@ -170,7 +170,7 @@ public function getCustomerId() /** * Sets customerId - * @param string $customerId Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $customerId Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. * @return $this */ public function setCustomerId($customerId) diff --git a/lib/Model/PushFunds201ResponseOrderInformationAmountDetails.php b/lib/Model/PushFunds201ResponseOrderInformationAmountDetails.php index 355e51efe..dc40a45a6 100644 --- a/lib/Model/PushFunds201ResponseOrderInformationAmountDetails.php +++ b/lib/Model/PushFunds201ResponseOrderInformationAmountDetails.php @@ -194,7 +194,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. Note For Visa Platform Conenct, FDC Compass, and Chase Paymentech processors, the maximum length for this field is 12 numbers. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.994 Chase Paymentech: .01-9999999999.99 + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * @return $this */ public function setTotalAmount($totalAmount) diff --git a/lib/Model/PushFunds201ResponseProcessorInformation.php b/lib/Model/PushFunds201ResponseProcessorInformation.php index 740a0576d..35079f751 100644 --- a/lib/Model/PushFunds201ResponseProcessorInformation.php +++ b/lib/Model/PushFunds201ResponseProcessorInformation.php @@ -55,9 +55,7 @@ class PushFunds201ResponseProcessorInformation implements ArrayAccess protected static $swaggerTypes = [ 'transactionId' => 'int', 'responseCode' => 'string', - 'approvalCode' => 'string', 'systemTraceAuditNumber' => 'string', - 'responseCodeSource' => 'string', 'retrievalReferenceNumber' => 'string' ]; @@ -68,9 +66,7 @@ class PushFunds201ResponseProcessorInformation implements ArrayAccess protected static $swaggerFormats = [ 'transactionId' => null, 'responseCode' => null, - 'approvalCode' => null, 'systemTraceAuditNumber' => null, - 'responseCodeSource' => null, 'retrievalReferenceNumber' => null ]; @@ -91,9 +87,7 @@ public static function swaggerFormats() protected static $attributeMap = [ 'transactionId' => 'transactionId', 'responseCode' => 'responseCode', - 'approvalCode' => 'approvalCode', 'systemTraceAuditNumber' => 'systemTraceAuditNumber', - 'responseCodeSource' => 'responseCodeSource', 'retrievalReferenceNumber' => 'retrievalReferenceNumber' ]; @@ -105,9 +99,7 @@ public static function swaggerFormats() protected static $setters = [ 'transactionId' => 'setTransactionId', 'responseCode' => 'setResponseCode', - 'approvalCode' => 'setApprovalCode', 'systemTraceAuditNumber' => 'setSystemTraceAuditNumber', - 'responseCodeSource' => 'setResponseCodeSource', 'retrievalReferenceNumber' => 'setRetrievalReferenceNumber' ]; @@ -119,9 +111,7 @@ public static function swaggerFormats() protected static $getters = [ 'transactionId' => 'getTransactionId', 'responseCode' => 'getResponseCode', - 'approvalCode' => 'getApprovalCode', 'systemTraceAuditNumber' => 'getSystemTraceAuditNumber', - 'responseCodeSource' => 'getResponseCodeSource', 'retrievalReferenceNumber' => 'getRetrievalReferenceNumber' ]; @@ -158,9 +148,7 @@ public function __construct(array $data = null) { $this->container['transactionId'] = isset($data['transactionId']) ? $data['transactionId'] : null; $this->container['responseCode'] = isset($data['responseCode']) ? $data['responseCode'] : null; - $this->container['approvalCode'] = isset($data['approvalCode']) ? $data['approvalCode'] : null; $this->container['systemTraceAuditNumber'] = isset($data['systemTraceAuditNumber']) ? $data['systemTraceAuditNumber'] : null; - $this->container['responseCodeSource'] = isset($data['responseCodeSource']) ? $data['responseCodeSource'] : null; $this->container['retrievalReferenceNumber'] = isset($data['retrievalReferenceNumber']) ? $data['retrievalReferenceNumber'] : null; } @@ -231,27 +219,6 @@ public function setResponseCode($responseCode) return $this; } - /** - * Gets approvalCode - * @return string - */ - public function getApprovalCode() - { - return $this->container['approvalCode']; - } - - /** - * Sets approvalCode - * @param string $approvalCode Issuer-generated approval code for the transaction. - * @return $this - */ - public function setApprovalCode($approvalCode) - { - $this->container['approvalCode'] = $approvalCode; - - return $this; - } - /** * Gets systemTraceAuditNumber * @return string @@ -263,7 +230,7 @@ public function getSystemTraceAuditNumber() /** * Sets systemTraceAuditNumber - * @param string $systemTraceAuditNumber System audit number. Returned by authorization and incremental authorization services. Visa Platform Connect System trace number that must be printed on the customer's receipt. + * @param string $systemTraceAuditNumber System audit number. Returned by authorization and incremental authorization services. * @return $this */ public function setSystemTraceAuditNumber($systemTraceAuditNumber) @@ -273,27 +240,6 @@ public function setSystemTraceAuditNumber($systemTraceAuditNumber) return $this; } - /** - * Gets responseCodeSource - * @return string - */ - public function getResponseCodeSource() - { - return $this->container['responseCodeSource']; - } - - /** - * Sets responseCodeSource - * @param string $responseCodeSource Used by Visa only and contains the response source/reason code that identifies the source of the response decision. - * @return $this - */ - public function setResponseCodeSource($responseCodeSource) - { - $this->container['responseCodeSource'] = $responseCodeSource; - - return $this; - } - /** * Gets retrievalReferenceNumber * @return string @@ -305,7 +251,7 @@ public function getRetrievalReferenceNumber() /** * Sets retrievalReferenceNumber - * @param string $retrievalReferenceNumber Unique reference number returned by the processor that identifies the transaction at the network. Supported by Mastercard Send + * @param string $retrievalReferenceNumber Unique reference number returned by the processor that identifies the transaction at the network. * @return $this */ public function setRetrievalReferenceNumber($retrievalReferenceNumber) diff --git a/lib/Model/PushFunds400Response.php b/lib/Model/PushFunds400Response.php index 9dddde81e..417f420dc 100644 --- a/lib/Model/PushFunds400Response.php +++ b/lib/Model/PushFunds400Response.php @@ -284,7 +284,7 @@ public function getMessage() /** * Sets message - * @param string $message The detail message related to the status and reason listed above. Possible values: - Declined - One or more fields in the request contains invalid data - Declined - The request is missing one or more fields - Declined - There is a problem with your CyberSource merchant configuration. + * @param string $message The detail message related to the status and reason listed above. Possible values: - One or more fields in the request contains invalid data. - The request is missing one or more required fields. - Declined - There is a problem with your CyberSource merchant configuration. * @return $this */ public function setMessage($message) diff --git a/lib/Model/PushFundsRequest.php b/lib/Model/PushFundsRequest.php index 1c7faaca4..3d03bbccd 100644 --- a/lib/Model/PushFundsRequest.php +++ b/lib/Model/PushFundsRequest.php @@ -56,13 +56,8 @@ class PushFundsRequest implements ArrayAccess 'clientReferenceInformation' => '\CyberSource\Model\Ptsv1pushfundstransferClientReferenceInformation', 'orderInformation' => '\CyberSource\Model\Ptsv1pushfundstransferOrderInformation', 'processingInformation' => '\CyberSource\Model\Ptsv1pushfundstransferProcessingInformation', - 'processingOptions' => '\CyberSource\Model\Ptsv1pushfundstransferProcessingOptions', 'recipientInformation' => '\CyberSource\Model\Ptsv1pushfundstransferRecipientInformation', - 'senderInformation' => '\CyberSource\Model\Ptsv1pushfundstransferSenderInformation', - 'aggregatorInformation' => '\CyberSource\Model\Ptsv1pushfundstransferAggregatorInformation', - 'merchantDefinedInformation' => '\CyberSource\Model\Ptsv1pushfundstransferMerchantDefinedInformation', - 'merchantInformation' => '\CyberSource\Model\Ptsv1pushfundstransferMerchantInformation', - 'pointOfServiceInformation' => '\CyberSource\Model\Ptsv1pushfundstransferPointOfServiceInformation' + 'senderInformation' => '\CyberSource\Model\Ptsv1pushfundstransferSenderInformation' ]; /** @@ -73,13 +68,8 @@ class PushFundsRequest implements ArrayAccess 'clientReferenceInformation' => null, 'orderInformation' => null, 'processingInformation' => null, - 'processingOptions' => null, 'recipientInformation' => null, - 'senderInformation' => null, - 'aggregatorInformation' => null, - 'merchantDefinedInformation' => null, - 'merchantInformation' => null, - 'pointOfServiceInformation' => null + 'senderInformation' => null ]; public static function swaggerTypes() @@ -100,13 +90,8 @@ public static function swaggerFormats() 'clientReferenceInformation' => 'clientReferenceInformation', 'orderInformation' => 'orderInformation', 'processingInformation' => 'processingInformation', - 'processingOptions' => 'processingOptions', 'recipientInformation' => 'recipientInformation', - 'senderInformation' => 'senderInformation', - 'aggregatorInformation' => 'aggregatorInformation', - 'merchantDefinedInformation' => 'merchantDefinedInformation', - 'merchantInformation' => 'merchantInformation', - 'pointOfServiceInformation' => 'pointOfServiceInformation' + 'senderInformation' => 'senderInformation' ]; @@ -118,13 +103,8 @@ public static function swaggerFormats() 'clientReferenceInformation' => 'setClientReferenceInformation', 'orderInformation' => 'setOrderInformation', 'processingInformation' => 'setProcessingInformation', - 'processingOptions' => 'setProcessingOptions', 'recipientInformation' => 'setRecipientInformation', - 'senderInformation' => 'setSenderInformation', - 'aggregatorInformation' => 'setAggregatorInformation', - 'merchantDefinedInformation' => 'setMerchantDefinedInformation', - 'merchantInformation' => 'setMerchantInformation', - 'pointOfServiceInformation' => 'setPointOfServiceInformation' + 'senderInformation' => 'setSenderInformation' ]; @@ -136,13 +116,8 @@ public static function swaggerFormats() 'clientReferenceInformation' => 'getClientReferenceInformation', 'orderInformation' => 'getOrderInformation', 'processingInformation' => 'getProcessingInformation', - 'processingOptions' => 'getProcessingOptions', 'recipientInformation' => 'getRecipientInformation', - 'senderInformation' => 'getSenderInformation', - 'aggregatorInformation' => 'getAggregatorInformation', - 'merchantDefinedInformation' => 'getMerchantDefinedInformation', - 'merchantInformation' => 'getMerchantInformation', - 'pointOfServiceInformation' => 'getPointOfServiceInformation' + 'senderInformation' => 'getSenderInformation' ]; public static function attributeMap() @@ -179,13 +154,8 @@ public function __construct(array $data = null) $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; $this->container['orderInformation'] = isset($data['orderInformation']) ? $data['orderInformation'] : null; $this->container['processingInformation'] = isset($data['processingInformation']) ? $data['processingInformation'] : null; - $this->container['processingOptions'] = isset($data['processingOptions']) ? $data['processingOptions'] : null; $this->container['recipientInformation'] = isset($data['recipientInformation']) ? $data['recipientInformation'] : null; $this->container['senderInformation'] = isset($data['senderInformation']) ? $data['senderInformation'] : null; - $this->container['aggregatorInformation'] = isset($data['aggregatorInformation']) ? $data['aggregatorInformation'] : null; - $this->container['merchantDefinedInformation'] = isset($data['merchantDefinedInformation']) ? $data['merchantDefinedInformation'] : null; - $this->container['merchantInformation'] = isset($data['merchantInformation']) ? $data['merchantInformation'] : null; - $this->container['pointOfServiceInformation'] = isset($data['pointOfServiceInformation']) ? $data['pointOfServiceInformation'] : null; } /** @@ -203,9 +173,6 @@ public function listInvalidProperties() if ($this->container['processingInformation'] === null) { $invalid_properties[] = "'processingInformation' can't be null"; } - if ($this->container['senderInformation'] === null) { - $invalid_properties[] = "'senderInformation' can't be null"; - } return $invalid_properties; } @@ -224,9 +191,6 @@ public function valid() if ($this->container['processingInformation'] === null) { return false; } - if ($this->container['senderInformation'] === null) { - return false; - } return true; } @@ -294,27 +258,6 @@ public function setProcessingInformation($processingInformation) return $this; } - /** - * Gets processingOptions - * @return \CyberSource\Model\Ptsv1pushfundstransferProcessingOptions - */ - public function getProcessingOptions() - { - return $this->container['processingOptions']; - } - - /** - * Sets processingOptions - * @param \CyberSource\Model\Ptsv1pushfundstransferProcessingOptions $processingOptions - * @return $this - */ - public function setProcessingOptions($processingOptions) - { - $this->container['processingOptions'] = $processingOptions; - - return $this; - } - /** * Gets recipientInformation * @return \CyberSource\Model\Ptsv1pushfundstransferRecipientInformation @@ -356,90 +299,6 @@ public function setSenderInformation($senderInformation) return $this; } - - /** - * Gets aggregatorInformation - * @return \CyberSource\Model\Ptsv1pushfundstransferAggregatorInformation - */ - public function getAggregatorInformation() - { - return $this->container['aggregatorInformation']; - } - - /** - * Sets aggregatorInformation - * @param \CyberSource\Model\Ptsv1pushfundstransferAggregatorInformation $aggregatorInformation - * @return $this - */ - public function setAggregatorInformation($aggregatorInformation) - { - $this->container['aggregatorInformation'] = $aggregatorInformation; - - return $this; - } - - /** - * Gets merchantDefinedInformation - * @return \CyberSource\Model\Ptsv1pushfundstransferMerchantDefinedInformation - */ - public function getMerchantDefinedInformation() - { - return $this->container['merchantDefinedInformation']; - } - - /** - * Sets merchantDefinedInformation - * @param \CyberSource\Model\Ptsv1pushfundstransferMerchantDefinedInformation $merchantDefinedInformation - * @return $this - */ - public function setMerchantDefinedInformation($merchantDefinedInformation) - { - $this->container['merchantDefinedInformation'] = $merchantDefinedInformation; - - return $this; - } - - /** - * Gets merchantInformation - * @return \CyberSource\Model\Ptsv1pushfundstransferMerchantInformation - */ - public function getMerchantInformation() - { - return $this->container['merchantInformation']; - } - - /** - * Sets merchantInformation - * @param \CyberSource\Model\Ptsv1pushfundstransferMerchantInformation $merchantInformation - * @return $this - */ - public function setMerchantInformation($merchantInformation) - { - $this->container['merchantInformation'] = $merchantInformation; - - return $this; - } - - /** - * Gets pointOfServiceInformation - * @return \CyberSource\Model\Ptsv1pushfundstransferPointOfServiceInformation - */ - public function getPointOfServiceInformation() - { - return $this->container['pointOfServiceInformation']; - } - - /** - * Sets pointOfServiceInformation - * @param \CyberSource\Model\Ptsv1pushfundstransferPointOfServiceInformation $pointOfServiceInformation - * @return $this - */ - public function setPointOfServiceInformation($pointOfServiceInformation) - { - $this->container['pointOfServiceInformation'] = $pointOfServiceInformation; - - return $this; - } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Rbsv1plansOrderInformationAmountDetails.php b/lib/Model/Rbsv1plansOrderInformationAmountDetails.php index 7d39840cd..98055d2d4 100644 --- a/lib/Model/Rbsv1plansOrderInformationAmountDetails.php +++ b/lib/Model/Rbsv1plansOrderInformationAmountDetails.php @@ -194,7 +194,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.php b/lib/Model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.php index 1aefb77eb..37167da5f 100644 --- a/lib/Model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.php +++ b/lib/Model/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.php @@ -212,7 +212,7 @@ public function getAddressType() /** * Sets addressType - * @param string $addressType Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. For possible values, see the description for the `dav_address_type` reply field in [CyberSource Verification Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/) #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown. + * @param string $addressType Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown. * @return $this */ public function setAddressType($addressType) diff --git a/lib/Model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.php b/lib/Model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.php index c4c41713e..21024ec8d 100644 --- a/lib/Model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.php +++ b/lib/Model/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.php @@ -524,7 +524,7 @@ public function getAuthenticationPath() /** * Sets authenticationPath - * @param string $authenticationPath Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) + * @param string $authenticationPath Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. * @return $this */ public function setAuthenticationPath($authenticationPath) @@ -1007,7 +1007,7 @@ public function getProofXml() /** * Sets proofXml - * @param string $proofXml Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. + * @param string $proofXml Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback. * @return $this */ public function setProofXml($proofXml) @@ -1196,7 +1196,7 @@ public function getVeresEnrolled() /** * Sets veresEnrolled - * @param string $veresEnrolled Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) + * @param string $veresEnrolled Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. * @return $this */ public function setVeresEnrolled($veresEnrolled) diff --git a/lib/Model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.php b/lib/Model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.php index ce96cbb6c..2f39f094e 100644 --- a/lib/Model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.php +++ b/lib/Model/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.php @@ -170,7 +170,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/RiskV1DecisionsPost201ResponsePaymentInformation.php b/lib/Model/RiskV1DecisionsPost201ResponsePaymentInformation.php index cdb14d39d..27efb5eed 100644 --- a/lib/Model/RiskV1DecisionsPost201ResponsePaymentInformation.php +++ b/lib/Model/RiskV1DecisionsPost201ResponsePaymentInformation.php @@ -195,7 +195,7 @@ public function getBinCountry() /** * Sets binCountry - * @param string $binCountry Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $binCountry Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. * @return $this */ public function setBinCountry($binCountry) @@ -216,7 +216,7 @@ public function getAccountType() /** * Sets accountType - * @param string $accountType Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $accountType Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. * @return $this */ public function setAccountType($accountType) @@ -237,7 +237,7 @@ public function getIssuer() /** * Sets issuer - * @param string $issuer Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $issuer Name of the bank or entity that issued the card account. * @return $this */ public function setIssuer($issuer) @@ -258,7 +258,7 @@ public function getScheme() /** * Sets scheme - * @param string $scheme Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $scheme Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. * @return $this */ public function setScheme($scheme) @@ -279,7 +279,7 @@ public function getBin() /** * Sets bin - * @param string $bin Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $bin Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. * @return $this */ public function setBin($bin) diff --git a/lib/Model/Riskv1authenticationresultsOrderInformationAmountDetails.php b/lib/Model/Riskv1authenticationresultsOrderInformationAmountDetails.php index 8ad3bb419..3c46047de 100644 --- a/lib/Model/Riskv1authenticationresultsOrderInformationAmountDetails.php +++ b/lib/Model/Riskv1authenticationresultsOrderInformationAmountDetails.php @@ -177,7 +177,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) @@ -198,7 +198,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) diff --git a/lib/Model/Riskv1authenticationsBuyerInformation.php b/lib/Model/Riskv1authenticationsBuyerInformation.php index 0cbdba167..5caafe35c 100644 --- a/lib/Model/Riskv1authenticationsBuyerInformation.php +++ b/lib/Model/Riskv1authenticationsBuyerInformation.php @@ -194,7 +194,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @return $this */ public function setMerchantCustomerId($merchantCustomerId) diff --git a/lib/Model/Riskv1authenticationsOrderInformationAmountDetails.php b/lib/Model/Riskv1authenticationsOrderInformationAmountDetails.php index fc0114417..14d4f15bc 100644 --- a/lib/Model/Riskv1authenticationsOrderInformationAmountDetails.php +++ b/lib/Model/Riskv1authenticationsOrderInformationAmountDetails.php @@ -189,7 +189,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) @@ -210,7 +210,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) diff --git a/lib/Model/Riskv1authenticationsOrderInformationBillTo.php b/lib/Model/Riskv1authenticationsOrderInformationBillTo.php index 59bf71c72..9b543b9c6 100644 --- a/lib/Model/Riskv1authenticationsOrderInformationBillTo.php +++ b/lib/Model/Riskv1authenticationsOrderInformationBillTo.php @@ -461,7 +461,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/Riskv1decisionsBuyerInformation.php b/lib/Model/Riskv1decisionsBuyerInformation.php index 37ce9f6c3..c345a0847 100644 --- a/lib/Model/Riskv1decisionsBuyerInformation.php +++ b/lib/Model/Riskv1decisionsBuyerInformation.php @@ -195,7 +195,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @return $this */ public function setMerchantCustomerId($merchantCustomerId) @@ -237,7 +237,7 @@ public function getHashedPassword() /** * Sets hashedPassword - * @param string $hashedPassword The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $hashedPassword The merchant's password that CyberSource hashes and stores as a hashed password. * @return $this */ public function setHashedPassword($hashedPassword) @@ -258,7 +258,7 @@ public function getDateOfBirth() /** * Sets dateOfBirth - * @param string $dateOfBirth Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $dateOfBirth 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. * @return $this */ public function setDateOfBirth($dateOfBirth) diff --git a/lib/Model/Riskv1decisionsConsumerAuthenticationInformation.php b/lib/Model/Riskv1decisionsConsumerAuthenticationInformation.php index 0b3609fba..7fc09d364 100644 --- a/lib/Model/Riskv1decisionsConsumerAuthenticationInformation.php +++ b/lib/Model/Riskv1decisionsConsumerAuthenticationInformation.php @@ -626,7 +626,7 @@ public function getChallengeCode() /** * Sets challengeCode - * @param string $challengeCode Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html) + * @param string $challengeCode Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. * @return $this */ public function setChallengeCode($challengeCode) diff --git a/lib/Model/Riskv1decisionsOrderInformationAmountDetails.php b/lib/Model/Riskv1decisionsOrderInformationAmountDetails.php index c57b37c78..9be760325 100644 --- a/lib/Model/Riskv1decisionsOrderInformationAmountDetails.php +++ b/lib/Model/Riskv1decisionsOrderInformationAmountDetails.php @@ -183,7 +183,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/Riskv1decisionsOrderInformationBillTo.php b/lib/Model/Riskv1decisionsOrderInformationBillTo.php index 6fd40c176..479373dd6 100644 --- a/lib/Model/Riskv1decisionsOrderInformationBillTo.php +++ b/lib/Model/Riskv1decisionsOrderInformationBillTo.php @@ -392,7 +392,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/Riskv1decisionsProcessorInformationCardVerification.php b/lib/Model/Riskv1decisionsProcessorInformationCardVerification.php index eb4701c30..7def6ea01 100644 --- a/lib/Model/Riskv1decisionsProcessorInformationCardVerification.php +++ b/lib/Model/Riskv1decisionsProcessorInformationCardVerification.php @@ -170,7 +170,7 @@ public function getResultCode() /** * Sets resultCode - * @param string $resultCode CVN result code. For details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $resultCode CVN result code. * @return $this */ public function setResultCode($resultCode) diff --git a/lib/Model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.php b/lib/Model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.php index 652931f43..6b8a38040 100644 --- a/lib/Model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.php +++ b/lib/Model/Riskv1exportcomplianceinquiriesOrderInformationBillTo.php @@ -497,7 +497,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/Riskv1liststypeentriesOrderInformationBillTo.php b/lib/Model/Riskv1liststypeentriesOrderInformationBillTo.php index 4c7954faf..3d96a7e90 100644 --- a/lib/Model/Riskv1liststypeentriesOrderInformationBillTo.php +++ b/lib/Model/Riskv1liststypeentriesOrderInformationBillTo.php @@ -419,7 +419,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/TmsEmbeddedInstrumentIdentifier.php b/lib/Model/TmsEmbeddedInstrumentIdentifier.php index 15193c1ee..386e49351 100644 --- a/lib/Model/TmsEmbeddedInstrumentIdentifier.php +++ b/lib/Model/TmsEmbeddedInstrumentIdentifier.php @@ -58,7 +58,7 @@ class TmsEmbeddedInstrumentIdentifier implements ArrayAccess 'object' => 'string', 'state' => 'string', 'type' => 'string', - 'tokenProvisioningInformation' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation', + 'tokenProvisioningInformation' => '\CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation', 'card' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierCard', 'bankAccount' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierBankAccount', 'tokenizedCard' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenizedCard', @@ -326,7 +326,7 @@ public function getType() /** * Sets type - * @param string $type The type of Instrument Identifier. Possible Values: - enrollable card + * @param string $type The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token * @return $this */ public function setType($type) @@ -338,7 +338,7 @@ public function setType($type) /** * Gets tokenProvisioningInformation - * @return \CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation + * @return \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation */ public function getTokenProvisioningInformation() { @@ -347,7 +347,7 @@ public function getTokenProvisioningInformation() /** * Sets tokenProvisioningInformation - * @param \CyberSource\Model\TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation $tokenProvisioningInformation + * @param \CyberSource\Model\Ptsv2paymentsTokenInformationTokenProvisioningInformation $tokenProvisioningInformation * @return $this */ public function setTokenProvisioningInformation($tokenProvisioningInformation) diff --git a/lib/Model/TmsEmbeddedInstrumentIdentifierTokenizedCard.php b/lib/Model/TmsEmbeddedInstrumentIdentifierTokenizedCard.php index fd89a16a4..b3ceaa5a8 100644 --- a/lib/Model/TmsEmbeddedInstrumentIdentifierTokenizedCard.php +++ b/lib/Model/TmsEmbeddedInstrumentIdentifierTokenizedCard.php @@ -54,6 +54,7 @@ class TmsEmbeddedInstrumentIdentifierTokenizedCard implements ArrayAccess */ protected static $swaggerTypes = [ 'type' => 'string', + 'source' => 'string', 'state' => 'string', 'enrollmentId' => 'string', 'tokenReferenceId' => 'string', @@ -71,6 +72,7 @@ class TmsEmbeddedInstrumentIdentifierTokenizedCard implements ArrayAccess */ protected static $swaggerFormats = [ 'type' => null, + 'source' => null, 'state' => null, 'enrollmentId' => null, 'tokenReferenceId' => null, @@ -98,6 +100,7 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'type' => 'type', + 'source' => 'source', 'state' => 'state', 'enrollmentId' => 'enrollmentId', 'tokenReferenceId' => 'tokenReferenceId', @@ -116,6 +119,7 @@ public static function swaggerFormats() */ protected static $setters = [ 'type' => 'setType', + 'source' => 'setSource', 'state' => 'setState', 'enrollmentId' => 'setEnrollmentId', 'tokenReferenceId' => 'setTokenReferenceId', @@ -134,6 +138,7 @@ public static function swaggerFormats() */ protected static $getters = [ 'type' => 'getType', + 'source' => 'getSource', 'state' => 'getState', 'enrollmentId' => 'getEnrollmentId', 'tokenReferenceId' => 'getTokenReferenceId', @@ -177,6 +182,7 @@ public static function getters() public function __construct(array $data = null) { $this->container['type'] = isset($data['type']) ? $data['type'] : null; + $this->container['source'] = isset($data['source']) ? $data['source'] : null; $this->container['state'] = isset($data['state']) ? $data['state'] : null; $this->container['enrollmentId'] = isset($data['enrollmentId']) ? $data['enrollmentId'] : null; $this->container['tokenReferenceId'] = isset($data['tokenReferenceId']) ? $data['tokenReferenceId'] : null; @@ -234,6 +240,27 @@ public function setType($type) return $this; } + /** + * Gets source + * @return string + */ + public function getSource() + { + return $this->container['source']; + } + + /** + * Sets source + * @param string $source 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 + * @return $this + */ + public function setSource($source) + { + $this->container['source'] = $source; + + return $this; + } + /** * Gets state * @return string diff --git a/lib/Model/TssV2TransactionsGet200ResponseBuyerInformation.php b/lib/Model/TssV2TransactionsGet200ResponseBuyerInformation.php index 7cb96ab50..f1cf07e27 100644 --- a/lib/Model/TssV2TransactionsGet200ResponseBuyerInformation.php +++ b/lib/Model/TssV2TransactionsGet200ResponseBuyerInformation.php @@ -176,7 +176,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @return $this */ public function setMerchantCustomerId($merchantCustomerId) @@ -197,7 +197,7 @@ public function getHashedPassword() /** * Sets hashedPassword - * @param string $hashedPassword The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $hashedPassword The merchant's password that CyberSource hashes and stores as a hashed password. * @return $this */ public function setHashedPassword($hashedPassword) diff --git a/lib/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.php b/lib/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.php index 26a844cba..50819b682 100644 --- a/lib/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.php +++ b/lib/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.php @@ -194,7 +194,7 @@ public function getEciRaw() /** * Sets eciRaw - * @param string $eciRaw Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $eciRaw Raw electronic commerce indicator (ECI). * @return $this */ public function setEciRaw($eciRaw) @@ -236,7 +236,7 @@ public function getXid() /** * Sets xid - * @param string $xid Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $xid Transaction identifier. * @return $this */ public function setXid($xid) diff --git a/lib/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.php b/lib/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.php index e90c9a75b..20dcc98fa 100644 --- a/lib/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.php +++ b/lib/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.php @@ -206,7 +206,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + * @param string $totalAmount Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used. * @return $this */ public function setTotalAmount($totalAmount) @@ -227,7 +227,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) @@ -269,7 +269,7 @@ public function getAuthorizedAmount() /** * Sets authorizedAmount - * @param string $authorizedAmount Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. + * @param string $authorizedAmount Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. * @return $this */ public function setAuthorizedAmount($authorizedAmount) diff --git a/lib/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.php b/lib/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.php index 7174b5bfc..12cf68540 100644 --- a/lib/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.php +++ b/lib/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.php @@ -437,7 +437,7 @@ public function getCompany() /** * Sets company - * @param string $company Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $company Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @return $this */ public function setCompany($company) @@ -458,7 +458,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.php b/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.php index e257cf436..2a4795ead 100644 --- a/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.php +++ b/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.php @@ -206,7 +206,7 @@ public function getRoutingNumber() /** * Sets routingNumber - * @param string $routingNumber 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/) + * @param string $routingNumber Bank routing number. This is also called the transit number. * @return $this */ public function setRoutingNumber($routingNumber) @@ -227,7 +227,7 @@ public function getBranchCode() /** * Sets branchCode - * @param string $branchCode Code used to identify the branch of the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction. For all possible values, see the `branch_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $branchCode Code used to identify the branch of the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction. * @return $this */ public function setBranchCode($branchCode) @@ -248,7 +248,7 @@ public function getSwiftCode() /** * Sets swiftCode - * @param string $swiftCode Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $swiftCode Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. * @return $this */ public function setSwiftCode($swiftCode) @@ -269,7 +269,7 @@ public function getBankCode() /** * Sets bankCode - * @param string $bankCode Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $bankCode Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. * @return $this */ public function setBankCode($bankCode) @@ -290,7 +290,7 @@ public function getIban() /** * Sets iban - * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $iban International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. * @return $this */ public function setIban($iban) diff --git a/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.php b/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.php index bfd1bfa1e..897240fe6 100644 --- a/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.php +++ b/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.php @@ -311,7 +311,7 @@ public function getCheckDigit() /** * Sets checkDigit - * @param string $checkDigit Code used to validate the customer's account number. Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction. For all possible values, see the `bank_check_digit` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). + * @param string $checkDigit Code used to validate the customer's account number. Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction. * @return $this */ public function setCheckDigit($checkDigit) @@ -332,7 +332,7 @@ public function getEncoderId() /** * Sets encoderId - * @param string $encoderId Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. For details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $encoderId Identifier for the bank that provided the customer's encoded account number. To obtain the bank identifier, contact your processor. * @return $this */ public function setEncoderId($encoderId) diff --git a/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.php b/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.php index b4287e81a..cbda8bdb6 100644 --- a/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.php +++ b/lib/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.php @@ -176,7 +176,7 @@ public function getCustomerId() /** * Sets customerId - * @param string $customerId Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $customerId Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer's card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. * @return $this */ public function setCustomerId($customerId) diff --git a/lib/Model/TssV2TransactionsGet200ResponseProcessingInformation.php b/lib/Model/TssV2TransactionsGet200ResponseProcessingInformation.php index 5253c4039..11d9a0353 100644 --- a/lib/Model/TssV2TransactionsGet200ResponseProcessingInformation.php +++ b/lib/Model/TssV2TransactionsGet200ResponseProcessingInformation.php @@ -293,7 +293,7 @@ public function getCommerceIndicator() /** * Sets commerceIndicator - * @param string $commerceIndicator Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * @param string $commerceIndicator Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" * @return $this */ public function setCommerceIndicator($commerceIndicator) @@ -314,7 +314,7 @@ public function getCommerceIndicatorLabel() /** * Sets commerceIndicatorLabel - * @param string $commerceIndicatorLabel Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * @param string $commerceIndicatorLabel Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` * @return $this */ public function setCommerceIndicatorLabel($commerceIndicatorLabel) @@ -335,7 +335,7 @@ public function getBusinessApplicationId() /** * Sets businessApplicationId - * @param string $businessApplicationId Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) + * @param string $businessApplicationId Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. * @return $this */ public function setBusinessApplicationId($businessApplicationId) diff --git a/lib/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.php b/lib/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.php index b7a0761f6..7ea2eb3ca 100644 --- a/lib/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.php +++ b/lib/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.php @@ -194,7 +194,7 @@ public function getAuthType() /** * Sets authType - * @param string $authType Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### 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 more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). + * @param string $authType 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. * @return $this */ public function setAuthType($authType) diff --git a/lib/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.php b/lib/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.php index 65c385362..fdaf5ca10 100644 --- a/lib/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.php +++ b/lib/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.php @@ -224,7 +224,7 @@ public function getEmail() /** * Sets email - * @param string $email Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $email Mapped Electronic Verification response code for the customer's email address. * @return $this */ public function setEmail($email) @@ -308,7 +308,7 @@ public function getPhoneNumber() /** * Sets phoneNumber - * @param string $phoneNumber Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $phoneNumber Mapped Electronic Verification response code for the customer's phone number. * @return $this */ public function setPhoneNumber($phoneNumber) @@ -350,7 +350,7 @@ public function getStreet() /** * Sets street - * @param string $street Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $street Mapped Electronic Verification response code for the customer's street address. * @return $this */ public function setStreet($street) @@ -392,7 +392,7 @@ public function getPostalCode() /** * Sets postalCode - * @param string $postalCode Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $postalCode Mapped Electronic Verification response code for the customer's postal code. * @return $this */ public function setPostalCode($postalCode) diff --git a/lib/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.php b/lib/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.php index 3b14a06a2..a641fd369 100644 --- a/lib/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.php +++ b/lib/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.php @@ -170,7 +170,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @param string $merchantCustomerId Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. * @return $this */ public function setMerchantCustomerId($merchantCustomerId) diff --git a/lib/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.php b/lib/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.php index 97414e467..03bda6fbe 100644 --- a/lib/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.php +++ b/lib/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.php @@ -182,7 +182,7 @@ public function getXid() /** * Sets xid - * @param string $xid Transaction identifier. For details, see `xid` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $xid Transaction identifier. * @return $this */ public function setXid($xid) @@ -224,7 +224,7 @@ public function getEciRaw() /** * Sets eciRaw - * @param string $eciRaw Raw electronic commerce indicator (ECI). For details, see `eci_raw` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + * @param string $eciRaw Raw electronic commerce indicator (ECI). * @return $this */ public function setEciRaw($eciRaw) diff --git a/lib/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.php b/lib/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.php index 5b1bc7d1c..a15296861 100644 --- a/lib/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.php +++ b/lib/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.php @@ -263,7 +263,7 @@ public function getEmail() /** * Sets email - * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. + * @param string $email Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. * @return $this */ public function setEmail($email) diff --git a/lib/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.php b/lib/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.php index 31b4671f0..d575f8868 100644 --- a/lib/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.php +++ b/lib/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.php @@ -209,7 +209,7 @@ public function getBusinessApplicationId() /** * Sets businessApplicationId - * @param string $businessApplicationId Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) + * @param string $businessApplicationId Payouts transaction type. Required for OCT transactions. 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. **Note** When the request includes this field, this value overrides the information in your CyberSource account. * @return $this */ public function setBusinessApplicationId($businessApplicationId) @@ -230,7 +230,7 @@ public function getCommerceIndicator() /** * Sets commerceIndicator - * @param string $commerceIndicator Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * @param string $commerceIndicator Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" * @return $this */ public function setCommerceIndicator($commerceIndicator) @@ -251,7 +251,7 @@ public function getCommerceIndicatorLabel() /** * Sets commerceIndicatorLabel - * @param string $commerceIndicatorLabel Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \"Payer Authentication,\" page 195. #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" + * @param string $commerceIndicatorLabel Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` * @return $this */ public function setCommerceIndicatorLabel($commerceIndicatorLabel) diff --git a/lib/Model/VasV2TaxVoid200ResponseVoidAmountDetails.php b/lib/Model/VasV2TaxVoid200ResponseVoidAmountDetails.php index 0ae187489..85f105988 100644 --- a/lib/Model/VasV2TaxVoid200ResponseVoidAmountDetails.php +++ b/lib/Model/VasV2TaxVoid200ResponseVoidAmountDetails.php @@ -197,7 +197,7 @@ public function getCurrency() /** * Sets currency - * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### 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). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. + * @param string $currency Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** 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. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. * @return $this */ public function setCurrency($currency) diff --git a/lib/Model/Vasv2taxBuyerInformation.php b/lib/Model/Vasv2taxBuyerInformation.php index cea95168a..6787f5fbc 100644 --- a/lib/Model/Vasv2taxBuyerInformation.php +++ b/lib/Model/Vasv2taxBuyerInformation.php @@ -170,7 +170,7 @@ public function getVatRegistrationNumber() /** * Sets vatRegistrationNumber - * @param string $vatRegistrationNumber Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + * @param string $vatRegistrationNumber Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. * @return $this */ public function setVatRegistrationNumber($vatRegistrationNumber) diff --git a/lib/Model/Vasv2taxClientReferenceInformation.php b/lib/Model/Vasv2taxClientReferenceInformation.php index d5ad87dee..902f3ff18 100644 --- a/lib/Model/Vasv2taxClientReferenceInformation.php +++ b/lib/Model/Vasv2taxClientReferenceInformation.php @@ -224,7 +224,7 @@ public function getComments() /** * Sets comments - * @param string $comments Comments + * @param string $comments Brief description of the order or any comment you wish to add to the order. * @return $this */ public function setComments($comments) diff --git a/lib/Model/Vasv2taxidClientReferenceInformation.php b/lib/Model/Vasv2taxidClientReferenceInformation.php index e7179da8e..0b295dbd5 100644 --- a/lib/Model/Vasv2taxidClientReferenceInformation.php +++ b/lib/Model/Vasv2taxidClientReferenceInformation.php @@ -203,7 +203,7 @@ public function getComments() /** * Sets comments - * @param string $comments Comments + * @param string $comments Brief description of the order or any comment you wish to add to the order. * @return $this */ public function setComments($comments) diff --git a/test/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchantTest.php b/test/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchantTest.php deleted file mode 100644 index 9d9635c0e..000000000 --- a/test/Model/Ptsv1pushfundstransferAggregatorInformationSubMerchantTest.php +++ /dev/null @@ -1,141 +0,0 @@ - Date: Mon, 1 Jul 2024 14:03:08 +0530 Subject: [PATCH 16/17] removed apcu --- composer.json | 1 - 1 file changed, 1 deletion(-) diff --git a/composer.json b/composer.json index 3c7e0e4d3..aae1942d6 100644 --- a/composer.json +++ b/composer.json @@ -18,7 +18,6 @@ "ext-curl": "*", "ext-json": "*", "ext-mbstring": "*", - "cache/apcu-adapter": ">=1.1.0", "firebase/php-jwt": "^6.0.0", "monolog/monolog": ">=1.25.0", "web-token/jwt-framework": "^2.2.11|^3.3.5" From cd305e7354275992e8fd8ee2304b59087a7bba15 Mon Sep 17 00:00:00 2001 From: monkumar Date: Mon, 1 Jul 2024 18:12:29 +0530 Subject: [PATCH 17/17] version update --- README.md | 2 +- composer.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 97a570292..f0216b01d 100755 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ override the new secure-http default setting)*. { "require": { "php": ">=8.0.0", - "cybersource/rest-client-php": "0.0.51" + "cybersource/rest-client-php": "0.0.52" } } ``` diff --git a/composer.json b/composer.json index aae1942d6..1b0bbf6af 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "cybersource/rest-client-php", - "version": "0.0.51", + "version": "0.0.52", "description": "Client SDK for CyberSource REST APIs", "keywords": [ "cybersource", "payments", "ecommerce", "merchant", "merchants", "authorize", "visa", "payment", "payment-gateway", "payment-integration", "payment-module", "payment-processing", "payment-service", "payment-methods"