From d9b79b0c7b1ec41c3ba4a6a20af4257a4a2dbcb5 Mon Sep 17 00:00:00 2001 From: Aastvik Goel Date: Mon, 25 Aug 2025 15:44:12 +0530 Subject: [PATCH 01/12] minor fix --- authenticationsdk/util/MLEUtility.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/authenticationsdk/util/MLEUtility.py b/authenticationsdk/util/MLEUtility.py index 684b85cd..eb581ad9 100644 --- a/authenticationsdk/util/MLEUtility.py +++ b/authenticationsdk/util/MLEUtility.py @@ -108,7 +108,7 @@ def get_serial_number_from_certificate(certificate, merchant_config): break if not serial_number: - logger.warning(f"Serial number not found in MLE certificate for alias {merchant_config.mle_key_alias} in {merchant_config.p12_keyfilepath}.p12") + logger.warning(f"Serial number not found in MLE certificate for alias {merchant_config.mle_key_alias} in {merchant_config.p12KeyFilePath}") # Use the hex serial number from the certificate as fallback return format(certificate.serial_number, 'x') From ffc47b912a4a01d854dff1904366a423c9fd8395 Mon Sep 17 00:00:00 2001 From: Aastvik Goel Date: Mon, 1 Sep 2025 16:09:58 +0530 Subject: [PATCH 02/12] minor fix --- authenticationsdk/core/MerchantConfiguration.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/authenticationsdk/core/MerchantConfiguration.py b/authenticationsdk/core/MerchantConfiguration.py index 9d4377b3..40d84155 100644 --- a/authenticationsdk/core/MerchantConfiguration.py +++ b/authenticationsdk/core/MerchantConfiguration.py @@ -499,5 +499,5 @@ def validate_MLE_configuration(self): try: CertificateUtility.validate_path_and_file(self.mleForRequestPublicCertPath, "mleForRequestPublicCertPath", self.log_config) except Exception as err: - self.logger.error(err) + self.logger.error(str(err)) raise err From a84fce854c096e01a2f99225d9fd52414a345e34 Mon Sep 17 00:00:00 2001 From: Aastvik Goel Date: Mon, 1 Sep 2025 16:13:33 +0530 Subject: [PATCH 03/12] downgrading the PyJWT dependency --- authenticationsdk/core/MerchantConfiguration.py | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/authenticationsdk/core/MerchantConfiguration.py b/authenticationsdk/core/MerchantConfiguration.py index 40d84155..3f7a540e 100644 --- a/authenticationsdk/core/MerchantConfiguration.py +++ b/authenticationsdk/core/MerchantConfiguration.py @@ -499,5 +499,5 @@ def validate_MLE_configuration(self): try: CertificateUtility.validate_path_and_file(self.mleForRequestPublicCertPath, "mleForRequestPublicCertPath", self.log_config) except Exception as err: - self.logger.error(str(err)) + self.logger.error(str(err)) raise err diff --git a/setup.py b/setup.py index f3a26347..14b2bffb 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ install_requires=[ "certifi", "pycryptodome", - "PyJWT", + "PyJWT<2.10.0", "DateTime", "setuptools", "six", From c4d132a50d515e57b5a993c726557a3164c1cbd2 Mon Sep 17 00:00:00 2001 From: mahmishr Date: Mon, 8 Sep 2025 12:20:11 +0530 Subject: [PATCH 04/12] outbound MLE code --- CyberSource/api/payments_api.py | 6 +- CyberSource/api_client.py | 28 +++- authenticationsdk/jwt/Token.py | 14 +- authenticationsdk/util/Cache.py | 94 +++++++++++-- .../util/GlobalLabelParameters.py | 1 + authenticationsdk/util/MLEUtility.py | 128 +++++++++++++++++- 6 files changed, 253 insertions(+), 18 deletions(-) diff --git a/CyberSource/api/payments_api.py b/CyberSource/api/payments_api.py index 40cd5fc7..9abd7c30 100644 --- a/CyberSource/api/payments_api.py +++ b/CyberSource/api/payments_api.py @@ -277,7 +277,8 @@ def create_payment_with_http_info(self, create_payment_request, **kwargs): inbound_mle_status = "optional" if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_payment,create_payment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) - + if MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_payment,create_payment_with_http_info"): + isResponseMLE=True # Authentication setting auth_settings = [] @@ -294,7 +295,8 @@ def create_payment_with_http_info(self, create_payment_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLE=isResponseMLE) def create_session_request(self, create_session_req, **kwargs): """ diff --git a/CyberSource/api_client.py b/CyberSource/api_client.py index c6ffa3d6..0746f17f 100644 --- a/CyberSource/api_client.py +++ b/CyberSource/api_client.py @@ -31,6 +31,8 @@ from authenticationsdk.core.MerchantConfiguration import * from authenticationsdk.util.PropertiesUtil import * from authenticationsdk.util.GlobalLabelParameters import * +from authenticationsdk.util.MLEUtility import MLEUtility + from six.moves.urllib.parse import urlencode @@ -169,7 +171,7 @@ def set_configuration(self,config): self.host = self.mconfig.request_host # Calling the authentication header - def call_authentication_header(self, method, header_params, body, request_target=None): + def call_authentication_header(self, method, header_params, body, request_target=None, isResponseMLEforApi=False): time = self.mconfig.get_time() @@ -179,7 +181,7 @@ def call_authentication_header(self, method, header_params, body, request_target # header_params['v-c-solution-id'] = self.mconfig.solution_id auth = Authorization() - token = auth.get_token(self.mconfig, time, method, request_target, body) + token = auth.get_token(self.mconfig, time, method, request_target, body, isResponseMLEforApi) if self.mconfig.authentication_type.upper() == GlobalLabelParameters.HTTP.upper(): header_params['Accept-Encoding'] = '*' header_params['v-c-merchant-id'] = self.mconfig.merchant_id @@ -226,7 +228,7 @@ def __call_api(self, resource_path, method, body=None, post_params=None, files=None, response_type=None, auth_settings=None, callback=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, - _request_timeout=None): + _request_timeout=None, isResponseMLE=False): config = Configuration() @@ -309,6 +311,22 @@ def __call_api(self, resource_path, method, post_params=post_params, body=body, _preload_content=_preload_content, _request_timeout=_request_timeout) + + if hasattr(self, 'mconfig'): + + # Check if response MLE is enabled for this operation + if isResponseMLE: + # Try to decrypt the response if it's MLE encrypted + try: + if MLEUtility.check_is_mle_encrypted_response(response_data.data): + decrypted_data = MLEUtility.decrypt_mle_response_payload(self.mconfig, response_data.data) + response_data.data = decrypted_data + except Exception as e: + # Log the error but continue with the response + if hasattr(self.mconfig, 'log_config') and self.mconfig.log_config.enable_log: + import logging + logger = logging.getLogger(__name__) + logger.error(f"Failed to decrypt MLE response: {str(e)}") if self.download_file_path is None: self.last_response = response_data @@ -453,7 +471,7 @@ def call_api(self, resource_path, method, body=None, post_params=None, files=None, response_type=None, auth_settings=None, callback=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, - _request_timeout=None): + _request_timeout=None, isResponseMLEforApi=False): if header_params['Content-Type'] == 'application/x-www-form-urlencoded': post_params = body @@ -462,7 +480,7 @@ def call_api(self, resource_path, method, request_target = query_param_path if query_param_path else resource_path if self.mconfig.authentication_type.upper() != GlobalLabelParameters.MUTUAL_AUTH.upper(): - self.call_authentication_header(method, header_params, body, request_target) + self.call_authentication_header(method, header_params, body, request_target, isResponseMLEforApi=False) """ Makes the HTTP request (synchronous) and return the deserialized data. diff --git a/authenticationsdk/jwt/Token.py b/authenticationsdk/jwt/Token.py index f1d05dae..eccda2b1 100644 --- a/authenticationsdk/jwt/Token.py +++ b/authenticationsdk/jwt/Token.py @@ -11,12 +11,14 @@ def __init__(self): self.jwt_method = None self.date = None self.request_json_path_data = None + self.isResponseMLEforApi =False - def jwt_signature_token(self, mconfig, date_time, request_type_method, request_json_path_data=None): + def jwt_signature_token(self, mconfig, date_time, request_type_method, request_json_path_data=None, isResponseMLEforApi=False): self.merchant_config = mconfig self.jwt_method = request_type_method self.date = date_time self.request_json_path_data = request_json_path_data + self.isResponseMLEforApi = isResponseMLEforApi def get_token(self): return self.set_token() @@ -36,6 +38,11 @@ def set_token(self): def token_for_get_and_delete(self): # Setting the jwt body for JWT-get jwt_body = {GlobalLabelParameters.JWT_TIME: self.date} + + if self.isResponseMLEforApi: + if self.merchant_config.responseMleKID: + jwt_body['v-c-response-mle-kid'] = self.merchant_config.responseMleKID #check access properly + # reading the p12 file from cache memory cache_obj = FileCache() cache_memory = cache_obj.fetch_cached_p12_certificate(self.merchant_config, self.merchant_config.p12KeyFilePath, self.merchant_config.key_password) @@ -61,6 +68,11 @@ def token_for_post_and_put_and_patch(self): # Setting the jwt body for JWT-post jwt_body = {GlobalLabelParameters.JWT_DIGEST: digest.decode("utf-8"), GlobalLabelParameters.JWT_ALGORITHM: "SHA-256", GlobalLabelParameters.JWT_TIME: self.date} + + if self.isResponseMLEforApi: + if self.merchant_config.responseMleKID: + jwt_body['v-c-response-mle-kid'] = self.merchant_config.responseMleKID + # reading the p12 file from cache memory cache_obj = FileCache() cache_memory = cache_obj.fetch_cached_p12_certificate(self.merchant_config, self.merchant_config.p12KeyFilePath, self.merchant_config.key_password) diff --git a/authenticationsdk/util/Cache.py b/authenticationsdk/util/Cache.py index 3e4472f8..1485008e 100644 --- a/authenticationsdk/util/Cache.py +++ b/authenticationsdk/util/Cache.py @@ -7,14 +7,14 @@ from cryptography import x509 from cryptography.hazmat.primitives import serialization from cryptography.hazmat.backends import default_backend -from cryptography.hazmat.primitives.serialization import pkcs12 +from cryptography.hazmat.primitives.serialization import pkcs12, load_pem_private_key from typing_extensions import deprecated from authenticationsdk.util.CertificateUtility import CertificateUtility from authenticationsdk.util.GlobalLabelParameters import * import CyberSource.logging.log_factory as LogFactory -import threading +import os class CertInfo: def __init__(self, certificate, timestamp, private_key): @@ -101,11 +101,13 @@ def get_request_mle_cert_from_cache(self, merchant_config): certificate_file_path = None # Priority #1: Get cert from merchantConfig.mle_for_request_public_cert_path if certPath is provided - if merchant_config.mleForRequestPublicCertPath and merchant_config.mleForRequestPublicCertPath.strip(): + if (merchant_config.mleForRequestPublicCertPath and + merchant_config.mleForRequestPublicCertPath.strip()): certificate_identifier = GlobalLabelParameters.MLE_CACHE_IDENTIFIER_FOR_CONFIG_CERT certificate_file_path = merchant_config.mleForRequestPublicCertPath # Priority #2: If mle_for_request_public_cert_path not provided, get mlecert from p12 if provided and jwt auth type - elif (GlobalLabelParameters.JWT.lower() == merchant_config.authentication_type.lower() and merchant_config.p12KeyFilePath): + elif (GlobalLabelParameters.JWT.lower() == merchant_config.authentication_type.lower() and + merchant_config.p12KeyFilePath): certificate_identifier = GlobalLabelParameters.MLE_CACHE_IDENTIFIER_FOR_P12_CERT certificate_file_path = merchant_config.p12KeyFilePath # Priority #3: Get mlecert from default cert in SDK as per CAS or PROD env. @@ -130,7 +132,7 @@ def get_mle_cert_based_on_cache_key(self, merchant_config, cache_key, certificat return cert_info.certificate if cert_info else None - def setup_mle_cache(self, merchant_config, cache_key, certificate_file_path): + def setup_mle_cache(self, merchant_config, cache_key, file_path): if FileCache.logger is None: FileCache.logger = LogFactory.setup_logger(__name__, merchant_config.log_config) logger = FileCache.logger @@ -138,14 +140,55 @@ def setup_mle_cache(self, merchant_config, cache_key, certificate_file_path): mle_certificate = None private_key = None + # Handle Response MLE Private Key + if cache_key.endswith(GlobalLabelParameters.MLE_CACHE_KEY_IDENTIFIER_FOR_RESPONSE_PRIVATE_KEY): + try: + file_extension = os.path.splitext(file_path)[1].lower() + + # Handle different file formats + if file_extension in ['.p12', '.pfx']: + # PKCS#12 format + with open(file_path, 'rb') as f: + p12_data = f.read() + + password_bytes = merchant_config.responseMlePrivateKeyFilePassword.encode('utf-8') if merchant_config.responseMlePrivateKeyFilePassword else None + private_key, _, _ = pkcs12.load_key_and_certificates( + p12_data, password_bytes, default_backend() + ) + elif file_extension in ['.pem', '.key', '.p8']: + # PEM format + with open(file_path, 'rb') as f: + pem_data = f.read() + + password_bytes = merchant_config.responseMlePrivateKeyFilePassword.encode('utf-8') if merchant_config.responseMlePrivateKeyFilePassword else None + private_key = load_pem_private_key( + pem_data, password=password_bytes, backend=default_backend() + ) + else: + raise ValueError(f"Unsupported file format: {file_extension}") + + # Save to cache (thread-safe) + cert_info = CertInfo( + None, # No certificate for private key + os.path.getmtime(file_path), + private_key + ) + with self._mle_cache_lock: + self.mlecache[cache_key] = cert_info + + return + except Exception as e: + logger.error(f"Error loading Response MLE private key: {str(e)}") + raise ValueError(f"Error loading Response MLE private key: {str(e)}") + # Handle PEM certificate case if cache_key.endswith(GlobalLabelParameters.MLE_CACHE_IDENTIFIER_FOR_CONFIG_CERT): - certificates = CertificateUtility.load_certificates_from_pem_file(certificate_file_path) + certificates = CertificateUtility.load_certificates_from_pem_file(file_path) try: mle_certificate = CertificateUtility.get_cert_based_on_key_alias(certificates, merchant_config.requestMleKeyAlias) except Exception: if mle_certificate is None: - file_name = os.path.basename(certificate_file_path) + file_name = os.path.basename(file_path) logger.warning(f"No certificate found for the specified mle_key_alias '{merchant_config.requestMleKeyAlias}'. Using the first certificate from file {file_name} as the MLE request certificate.") mle_certificate = certificates[0] # Take first certificate @@ -162,8 +205,41 @@ def setup_mle_cache(self, merchant_config, cache_key, certificate_file_path): # Save to cache (thread-safe) cert_info = CertInfo( mle_certificate, - os.path.getmtime(certificate_file_path), + os.path.getmtime(file_path), private_key ) with self._mle_cache_lock: - self.mlecache[cache_key] = cert_info \ No newline at end of file + self.mlecache[cache_key] = cert_info + + def get_mle_response_private_key(self, merchant_config): + """ + Gets the private key for Response MLE decryption. + + :param merchant_config: Merchant configuration object + :return: Private key object for decryption + :raises ValueError: If the private key cannot be obtained + """ + merchant_id = merchant_config.merchant_id + identifier = GlobalLabelParameters.MLE_CACHE_KEY_IDENTIFIER_FOR_RESPONSE_PRIVATE_KEY + cache_key = f"{merchant_id}_{identifier}" + file_path = merchant_config.responseMlePrivateKeyFilePath + + if not file_path: + raise ValueError("Response MLE private key file path not provided") + + # Check if key exists in cache + cert_info = self.mlecache.get(cache_key) + + try: + file_timestamp = os.path.getmtime(file_path) + + # If not in cache or file was modified, load it + if cert_info is None or cert_info.timestamp != file_timestamp: + self.setup_mle_cache(merchant_config, cache_key, file_path) + cert_info = self.mlecache.get(cache_key) + + return cert_info.private_key if cert_info else None + except Exception as e: + if FileCache.logger: + FileCache.logger.error(f"Error getting Response MLE private key: {str(e)}") + raise ValueError(f"Error getting Response MLE private key: {str(e)}") diff --git a/authenticationsdk/util/GlobalLabelParameters.py b/authenticationsdk/util/GlobalLabelParameters.py index fd80faac..4aeb319a 100644 --- a/authenticationsdk/util/GlobalLabelParameters.py +++ b/authenticationsdk/util/GlobalLabelParameters.py @@ -99,3 +99,4 @@ class GlobalLabelParameters: MESSAGE_AFTER_MLE_REQUEST = "Request after MLE: " MLE_CACHE_IDENTIFIER_FOR_CONFIG_CERT = "mleCertFromMerchantConfig" MLE_CACHE_IDENTIFIER_FOR_P12_CERT = "mleCertFromP12" + MLE_CACHE_KEY_IDENTIFIER_FOR_RESPONSE_PRIVATE_KEY = "response_mle_private_key" diff --git a/authenticationsdk/util/MLEUtility.py b/authenticationsdk/util/MLEUtility.py index a8222450..0832be01 100644 --- a/authenticationsdk/util/MLEUtility.py +++ b/authenticationsdk/util/MLEUtility.py @@ -1,5 +1,6 @@ import json import time +import os from cryptography.hazmat.primitives import serialization from cryptography.x509.oid import NameOID @@ -8,9 +9,19 @@ from authenticationsdk.util.Cache import FileCache from authenticationsdk.util.GlobalLabelParameters import GlobalLabelParameters import CyberSource.logging.log_factory as LogFactory +from CyberSource.utilities.JWEResponse.JWEUtility import JWEUtility class MLEUtility: logger = None + _cache = None # Static cache instance + + @classmethod + def get_cache(cls): + """Get or create the shared cache instance""" + if cls._cache is None: + from authenticationsdk.util.Cache import FileCache + cls._cache = FileCache() + return cls._cache class MLEException(Exception): def __init__(self, message, errors=None): @@ -108,10 +119,125 @@ def encrypt_request_payload(merchant_config, request_body): logger.debug(GlobalLabelParameters.MESSAGE_AFTER_MLE_REQUEST + ' ' + str(mle_request)) return mle_request + + @staticmethod + def check_is_mle_encrypted_response(response_body): + """ + Checks if the response is MLE encrypted. + + :param response_body: Response body as string + :return: True if the response is MLE encrypted, False otherwise + """ + if response_body is None or not response_body.strip(): + return False + + try: + import json + response_json = json.loads(response_body) + + # Check if the JSON has exactly one key named "encryptedResponse" + if len(response_json) != 1: + return False + + if "encryptedResponse" in response_json: + value = response_json["encryptedResponse"] + return isinstance(value, str) + + return False + except Exception: + # If JSON parsing fails, it's not a valid JSON thus not an MLE response + return False + + @staticmethod + def decrypt_mle_response_payload(merchant_config, mle_response_body): + """ + Decrypts MLE encrypted response payload. + + :param merchant_config: Merchant configuration object + :param mle_response_body: Encrypted response body + :return: Decrypted response as string + :raises MLEException: If decryption fails + """ + + if not MLEUtility.check_is_mle_encrypted_response(mle_response_body): + raise MLEUtility.MLEException("Response body is not MLE encrypted.") + + try: + # Get private key for decryption + private_key = MLEUtility._get_mle_response_private_key(merchant_config) + + # Extract the JWE token + jwe_response_token = MLEUtility._get_response_mle_token(mle_response_body) + + if not jwe_response_token: + # If token extraction fails, return the original response + return mle_response_body + + # Use the existing JWEUtility for decryption + if MLEUtility.logger: + MLEUtility.logger.debug(f"LOG_NETWORK_RESPONSE_BEFORE_MLE_DECRYPTION: {mle_response_body}") + + decrypted_response = JWEUtility.decrypt_jwe_response_using_private_key( + private_key, jwe_response_token + ) + + if MLEUtility.logger: + MLEUtility.logger.debug(f"LOG_NETWORK_RESPONSE_AFTER_MLE_DECRYPTION: {decrypted_response}") + + return decrypted_response + + except Exception as e: + raise MLEUtility.MLEException(f"MLE Response decryption error: {str(e)}") + + @staticmethod + def _get_response_mle_token(mle_response_body): + """ + Extracts the JWE token from the MLE encrypted response. + + :param mle_response_body: MLE encrypted response body + :return: JWE token string or None if extraction fails + """ + try: + import json + response_json = json.loads(mle_response_body) + return response_json.get("encryptedResponse") + except Exception as e: + if MLEUtility.logger: + MLEUtility.logger.error(f"Failed to extract Response MLE token: {str(e)}") + return None + + @staticmethod + def _get_mle_response_private_key(merchant_config): + """ + Gets the private key for Response MLE decryption. + + :param merchant_config: Merchant configuration object + :return: Private key object for decryption + :raises MLEException: If the private key cannot be obtained + """ + # First priority - if privateKey is given in merchant config return that + if hasattr(merchant_config, 'responseMlePrivateKey') and merchant_config.responseMlePrivateKey: + return merchant_config.responseMlePrivateKey + + # Second priority - get the privateKey from the file path + try: + # Get from cache - directly use the cache instance + cache_obj = MLEUtility.get_cache() + + try: + private_key = cache_obj.get_mle_response_private_key(merchant_config) + if private_key is None: + raise MLEUtility.MLEException("Failed to get Response MLE private key from cache") + return private_key + except Exception as e: + raise MLEUtility.MLEException(f"Error getting Response MLE private key: {str(e)}") + + except Exception as e: + raise MLEUtility.MLEException(f"Error loading Response MLE private key: {str(e)}") @staticmethod def get_mle_certificate(merchant_config): - cache_obj = FileCache() + cache_obj = MLEUtility.get_cache() mle_certificate = cache_obj.get_request_mle_cert_from_cache(merchant_config) return mle_certificate From 22dc5a92ed0ca17388d03426232a5c6c7ab76cf9 Mon Sep 17 00:00:00 2001 From: mahmishr Date: Tue, 9 Sep 2025 14:15:15 +0530 Subject: [PATCH 05/12] refactoring --- CyberSource/api/payments_api.py | 7 ++-- CyberSource/api_client.py | 21 +++++++---- authenticationsdk/core/Authorization.py | 4 +- .../cybersource-python-template/api.mustache | 7 +++- .../api_client.mustache | 37 +++++++++++++++---- 5 files changed, 55 insertions(+), 21 deletions(-) diff --git a/CyberSource/api/payments_api.py b/CyberSource/api/payments_api.py index 9abd7c30..43368109 100644 --- a/CyberSource/api/payments_api.py +++ b/CyberSource/api/payments_api.py @@ -275,10 +275,11 @@ def create_payment_with_http_info(self, create_payment_request, **kwargs): body_params = process_body(body_params) inbound_mle_status = "optional" + isResponseMLEforApi = False if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_payment,create_payment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) - if MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_payment,create_payment_with_http_info"): - isResponseMLE=True + if MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_payment,create_payment_with_http_info"): + isResponseMLEforApi=True # Authentication setting auth_settings = [] @@ -296,7 +297,7 @@ def create_payment_with_http_info(self, create_payment_request, **kwargs): _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats, - isResponseMLE=isResponseMLE) + isResponseMLEforApi=isResponseMLEforApi) def create_session_request(self, create_session_req, **kwargs): """ diff --git a/CyberSource/api_client.py b/CyberSource/api_client.py index 0746f17f..6cda6c8c 100644 --- a/CyberSource/api_client.py +++ b/CyberSource/api_client.py @@ -17,6 +17,8 @@ import tempfile import threading import pkg_resources +import logging +import CyberSource.logging.log_factory as LogFactory from datetime import date, datetime @@ -154,6 +156,10 @@ def set_configuration(self,config): # To reinitialize with logging config self.rest_client = RESTClientObject(log_config=self.mconfig.log_config) + try: + self.logger = LogFactory.setup_logger(self.__class__.__name__, self.mconfig.log_config) + except Exception: + self.logger = logging.getLogger(self.__class__.__name__) set_client_cert = rconfig.set_merchantclientcert(config) set_proxy = rconfig.set_merchantproxyconfig(config) @@ -228,7 +234,7 @@ def __call_api(self, resource_path, method, body=None, post_params=None, files=None, response_type=None, auth_settings=None, callback=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, - _request_timeout=None, isResponseMLE=False): + _request_timeout=None, isResponseMLEforApi=False): config = Configuration() @@ -315,7 +321,7 @@ def __call_api(self, resource_path, method, if hasattr(self, 'mconfig'): # Check if response MLE is enabled for this operation - if isResponseMLE: + if isResponseMLEforApi: # Try to decrypt the response if it's MLE encrypted try: if MLEUtility.check_is_mle_encrypted_response(response_data.data): @@ -323,10 +329,11 @@ def __call_api(self, resource_path, method, response_data.data = decrypted_data except Exception as e: # Log the error but continue with the response - if hasattr(self.mconfig, 'log_config') and self.mconfig.log_config.enable_log: - import logging - logger = logging.getLogger(__name__) - logger.error(f"Failed to decrypt MLE response: {str(e)}") + if (hasattr(self, "logger") and + hasattr(self.mconfig, "log_config") and + self.mconfig.log_config.enable_log): + self.logger.error(f"[MLE] Failed to decrypt response resource_path={resource_path} " + f"error={type(e).__name__}: {e}") if self.download_file_path is None: self.last_response = response_data @@ -480,7 +487,7 @@ def call_api(self, resource_path, method, request_target = query_param_path if query_param_path else resource_path if self.mconfig.authentication_type.upper() != GlobalLabelParameters.MUTUAL_AUTH.upper(): - self.call_authentication_header(method, header_params, body, request_target, isResponseMLEforApi=False) + self.call_authentication_header(method, header_params, body, request_target, isResponseMLEforApi) """ Makes the HTTP request (synchronous) and return the deserialized data. diff --git a/authenticationsdk/core/Authorization.py b/authenticationsdk/core/Authorization.py index 937d293e..ba3e3e69 100644 --- a/authenticationsdk/core/Authorization.py +++ b/authenticationsdk/core/Authorization.py @@ -13,7 +13,7 @@ def __init__(self): self.logger = None # This method generates and return a encrypted signature based on the Authentication type - def get_token(self, mconfig, date_time, request_type_method, request_target=None, request_json_path_data=None, logger=None): + def get_token(self, mconfig, date_time, request_type_method, request_target=None, request_json_path_data=None, logger=None, isResponseMLEforApi=False): authentication_type = mconfig.authentication_type self.validate_request_type_method(request_type_method) # Initializing the logger object @@ -46,7 +46,7 @@ def get_token(self, mconfig, date_time, request_type_method, request_target=None # JWT-Call elif authentication_type.upper() == GlobalLabelParameters.JWT.upper(): jwt_sig_token = JwtSignatureToken() - jwt_sig_token.jwt_signature_token(mconfig, date_time, request_type_method, request_json_path_data) + jwt_sig_token.jwt_signature_token(mconfig, date_time, request_type_method, request_json_path_data, isResponseMLEforApi) sig_token_jwt = jwt_sig_token.get_token() # Logging the parameters Content-Type,Merchant id,Date ,Host to the log file diff --git a/generator/cybersource-python-template/api.mustache b/generator/cybersource-python-template/api.mustache index 07ca200d..b5b8c3ca 100644 --- a/generator/cybersource-python-template/api.mustache +++ b/generator/cybersource-python-template/api.mustache @@ -214,6 +214,10 @@ class {{classname}}(object): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "{{operationId}},{{operationId}}_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = False + if MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "{{operationId}},{{operationId}}_with_http_info"): + isResponseMLEforApi = True + # Authentication setting auth_settings = [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}] @@ -230,6 +234,7 @@ class {{classname}}(object): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) {{/operation}} {{/operations}} diff --git a/generator/cybersource-python-template/api_client.mustache b/generator/cybersource-python-template/api_client.mustache index 0dab8c36..93228d4a 100644 --- a/generator/cybersource-python-template/api_client.mustache +++ b/generator/cybersource-python-template/api_client.mustache @@ -23,7 +23,10 @@ from authenticationsdk.core.Authorization import * from authenticationsdk.core.MerchantConfiguration import * from authenticationsdk.util.PropertiesUtil import * from authenticationsdk.util.GlobalLabelParameters import * +from authenticationsdk.util.MLEUtility import MLEUtility from six.moves.urllib.parse import urlencode +import logging +import CyberSource.logging.log_factory as LogFactory class ApiClient(object): @@ -145,6 +148,11 @@ class ApiClient(object): # To reinitialize with logging config self.rest_client = RESTClientObject(log_config=self.mconfig.log_config) + try: + self.logger = LogFactory.setup_logger(self.__class__.__name__, self.mconfig.log_config) + except Exception: + self.logger = logging.getLogger(self.__class__.__name__) + set_client_cert = rconfig.set_merchantclientcert(config) set_proxy = rconfig.set_merchantproxyconfig(config) @@ -161,7 +169,7 @@ class ApiClient(object): self.host = self.mconfig.request_host # Calling the authentication header - def call_authentication_header(self, method, header_params, body, request_target=None): + def call_authentication_header(self, method, header_params, body, request_target=None, isResponseMLEforApi=False): time = self.mconfig.get_time() @@ -218,7 +226,7 @@ class ApiClient(object): body=None, post_params=None, files=None, response_type=None, auth_settings=None, callback=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, - _request_timeout=None): + _request_timeout=None, isResponseMLEforApi=False): config = Configuration() @@ -302,6 +310,19 @@ class ApiClient(object): _preload_content=_preload_content, _request_timeout=_request_timeout) + if hasattr(self, 'mconfig'): + if isResponseMLEforApi: + try: + if MLEUtility.check_is_mle_encrypted_response(response_data.data): + decrypted_data = MLEUtility.decrypt_mle_response_payload(self.mconfig, response_data.data) + response_data.data = decrypted_data + except Exception as e: + if (hasattr(self, "logger") and + hasattr(self.mconfig, "log_config") and + self.mconfig.log_config.enable_log): + self.logger.error(f"[MLE] Failed to decrypt response resource_path={resource_path} " + f"error={type(e).__name__}: {e}") + if self.download_file_path is None: self.last_response = response_data @@ -445,16 +466,15 @@ class ApiClient(object): body=None, post_params=None, files=None, response_type=None, auth_settings=None, callback=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, - _request_timeout=None): + _request_timeout=None, isResponseMLEforApi=False): if header_params['Content-Type'] == 'application/x-www-form-urlencoded': post_params = body query_param_path = self.set_query_params(resource_path, query_params) - request_target = query_param_path if query_param_path else resource_pat - + request_target = query_param_path if query_param_path else resource_path if self.mconfig.authentication_type.upper() != GlobalLabelParameters.MUTUAL_AUTH.upper(): - self.call_authentication_header(method, header_params, body, request_target) + self.call_authentication_header(method, header_params, body, request_target, isResponseMLEforApi=isResponseMLEforApi) """ Makes the HTTP request (synchronous) and return the deserialized data. @@ -495,7 +515,8 @@ class ApiClient(object): path_params, query_params, header_params, body, post_params, files, response_type, auth_settings, callback, - _return_http_data_only, collection_formats, _preload_content, _request_timeout) + _return_http_data_only, collection_formats, _preload_content, _request_timeout, + isResponseMLEforApi=isResponseMLEforApi) else: thread = threading.Thread(target=self.__call_api, args=(resource_path, method, @@ -504,7 +525,7 @@ class ApiClient(object): post_params, files, response_type, auth_settings, callback, _return_http_data_only, - collection_formats, _preload_content, _request_timeout)) + collection_formats, _preload_content, _request_timeout, isResponseMLEforApi)) thread.start() return thread From 319f37548997b2bd64e83f72d99c6bb37dcb979e Mon Sep 17 00:00:00 2001 From: mahmishr Date: Tue, 9 Sep 2025 15:56:36 +0530 Subject: [PATCH 06/12] refactoring --- CyberSource/api_client.py | 8 ++++---- authenticationsdk/util/MLEUtility.py | 2 +- generator/cybersource-python-template/api_client.mustache | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CyberSource/api_client.py b/CyberSource/api_client.py index 6cda6c8c..3b85a5b4 100644 --- a/CyberSource/api_client.py +++ b/CyberSource/api_client.py @@ -187,7 +187,7 @@ def call_authentication_header(self, method, header_params, body, request_target # header_params['v-c-solution-id'] = self.mconfig.solution_id auth = Authorization() - token = auth.get_token(self.mconfig, time, method, request_target, body, isResponseMLEforApi) + token = auth.get_token(self.mconfig, time, method, request_target, body, isResponseMLEforApi=isResponseMLEforApi) if self.mconfig.authentication_type.upper() == GlobalLabelParameters.HTTP.upper(): header_params['Accept-Encoding'] = '*' header_params['v-c-merchant-id'] = self.mconfig.merchant_id @@ -487,7 +487,7 @@ def call_api(self, resource_path, method, request_target = query_param_path if query_param_path else resource_path if self.mconfig.authentication_type.upper() != GlobalLabelParameters.MUTUAL_AUTH.upper(): - self.call_authentication_header(method, header_params, body, request_target, isResponseMLEforApi) + self.call_authentication_header(method, header_params, body, request_target, isResponseMLEforApi=isResponseMLEforApi) """ Makes the HTTP request (synchronous) and return the deserialized data. @@ -528,7 +528,7 @@ def call_api(self, resource_path, method, path_params, query_params, header_params, body, post_params, files, response_type, auth_settings, callback, - _return_http_data_only, collection_formats, _preload_content, _request_timeout) + _return_http_data_only, collection_formats, _preload_content, _request_timeout, isResponseMLEforApi=isResponseMLEforApi) else: thread = threading.Thread(target=self.__call_api, args=(resource_path, method, @@ -537,7 +537,7 @@ def call_api(self, resource_path, method, post_params, files, response_type, auth_settings, callback, _return_http_data_only, - collection_formats, _preload_content, _request_timeout)) + collection_formats, _preload_content, _request_timeout, isResponseMLEforApi)) thread.start() return thread diff --git a/authenticationsdk/util/MLEUtility.py b/authenticationsdk/util/MLEUtility.py index 0832be01..7ad4fb7c 100644 --- a/authenticationsdk/util/MLEUtility.py +++ b/authenticationsdk/util/MLEUtility.py @@ -5,6 +5,7 @@ from cryptography.hazmat.primitives import serialization from cryptography.x509.oid import NameOID from jwcrypto import jwe, jwk +import json from authenticationsdk.util.Cache import FileCache from authenticationsdk.util.GlobalLabelParameters import GlobalLabelParameters @@ -132,7 +133,6 @@ def check_is_mle_encrypted_response(response_body): return False try: - import json response_json = json.loads(response_body) # Check if the JSON has exactly one key named "encryptedResponse" diff --git a/generator/cybersource-python-template/api_client.mustache b/generator/cybersource-python-template/api_client.mustache index 93228d4a..ad2b84c1 100644 --- a/generator/cybersource-python-template/api_client.mustache +++ b/generator/cybersource-python-template/api_client.mustache @@ -179,7 +179,7 @@ class ApiClient(object): # header_params['v-c-solution-id'] = self.mconfig.solution_id auth = Authorization() - token = auth.get_token(self.mconfig, time, method, request_target, body) + token = auth.get_token(self.mconfig, time, method, request_target, body, isResponseMLEforApi=isResponseMLEforApi) if self.mconfig.authentication_type.upper() == GlobalLabelParameters.HTTP.upper(): header_params['Accept-Encoding'] = '*' header_params['v-c-merchant-id'] = self.mconfig.merchant_id From e2a7affdf1a1ff847ac37122a5b6e298755b366d Mon Sep 17 00:00:00 2001 From: mahmishr Date: Wed, 17 Sep 2025 14:04:33 +0530 Subject: [PATCH 07/12] code fixes and cleanup --- CyberSource/api/payments_api.py | 4 +- CyberSource/api_client.py | 26 ++++---- .../core/MerchantConfiguration.py | 65 ++++++++++++++----- authenticationsdk/util/Cache.py | 55 +++++++--------- authenticationsdk/util/CertificateUtility.py | 17 ++++- .../util/GlobalLabelParameters.py | 2 +- authenticationsdk/util/MLEUtility.py | 6 +- authenticationsdk/util/Utility.py | 20 ++++++ 8 files changed, 123 insertions(+), 72 deletions(-) diff --git a/CyberSource/api/payments_api.py b/CyberSource/api/payments_api.py index 43368109..cf663682 100644 --- a/CyberSource/api/payments_api.py +++ b/CyberSource/api/payments_api.py @@ -275,11 +275,9 @@ def create_payment_with_http_info(self, create_payment_request, **kwargs): body_params = process_body(body_params) inbound_mle_status = "optional" - isResponseMLEforApi = False if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_payment,create_payment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) - if MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_payment,create_payment_with_http_info"): - isResponseMLEforApi=True + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_payment,create_payment_with_http_info") # Authentication setting auth_settings = [] diff --git a/CyberSource/api_client.py b/CyberSource/api_client.py index 3b85a5b4..8edfe8b3 100644 --- a/CyberSource/api_client.py +++ b/CyberSource/api_client.py @@ -319,21 +319,19 @@ def __call_api(self, resource_path, method, _request_timeout=_request_timeout) if hasattr(self, 'mconfig'): + try: + if MLEUtility.check_is_mle_encrypted_response(response_data.data): + decrypted_data = MLEUtility.decrypt_mle_response_payload(self.mconfig, response_data.data) + response_data.data = decrypted_data #check this + except Exception as e: + # Log the error but continue with the response + if (hasattr(self, "logger") and + hasattr(self.mconfig, "log_config") and + self.mconfig.log_config.enable_log): + self.logger.error(f"[MLE] Failed to decrypt response resource_path={resource_path} " + f"error={type(e).__name__}: {e}") + raise ApiException(status=500, reason=f"MLE response decryption failed: {e}") - # Check if response MLE is enabled for this operation - if isResponseMLEforApi: - # Try to decrypt the response if it's MLE encrypted - try: - if MLEUtility.check_is_mle_encrypted_response(response_data.data): - decrypted_data = MLEUtility.decrypt_mle_response_payload(self.mconfig, response_data.data) - response_data.data = decrypted_data - except Exception as e: - # Log the error but continue with the response - if (hasattr(self, "logger") and - hasattr(self.mconfig, "log_config") and - self.mconfig.log_config.enable_log): - self.logger.error(f"[MLE] Failed to decrypt response resource_path={resource_path} " - f"error={type(e).__name__}: {e}") if self.download_file_path is None: self.last_response = response_data diff --git a/authenticationsdk/core/MerchantConfiguration.py b/authenticationsdk/core/MerchantConfiguration.py index 58eabe26..b654073e 100644 --- a/authenticationsdk/core/MerchantConfiguration.py +++ b/authenticationsdk/core/MerchantConfiguration.py @@ -283,10 +283,6 @@ def set_requestMleKeyAlias(self, value): def get_requestMleKeyAlias(self): return self.requestMleKeyAlias - def set_mleForRequestPublicCertPath(self, value): - if not (value.get('mleForRequestPublicCertPath') is None): - self.mleForRequestPublicCertPath = value['mleForRequestPublicCertPath'] - def set_internalMapToControlMLEonAPI(self): if self.mapToControlMLEonAPI is not None: # Initialize internal maps @@ -534,8 +530,21 @@ def validate_merchant_details(self, details, mconfig = None): self.p12KeyFilePath = os.path.join(self.key_file_path, self.key_file_name) + GlobalLabelParameters.P12_PREFIX log_items = GlobalLabelParameters.HIDE_MERCHANT_CONFIG_PROPS + # To prevent pickling error from deep copying + _no_deepcopy_keys = { + "responseMlePrivateKeyFilePath", + "responseMlePrivateKeyFilePassword", + "responseMlePrivateKey" + } + _temp_details = {} + for _k, _v in details.items(): + if _k in _no_deepcopy_keys: + # Do not deepcopy; mask instead + _temp_details[_k] = "***" + else: + _temp_details[_k] = _v # This displays the logic for logging all cybs.json values - details_copy = copy.deepcopy(details) + details_copy = copy.deepcopy(_temp_details) if self.log_config.enable_log is True: for key, value in list(details_copy.items()): if key in log_items: @@ -585,16 +594,6 @@ def validate_MLE_configuration(self): except Exception as err: self.logger.error(err) raise err - - # use_mle = False - # if self.enableRequestMLEForOptionalApisGlobally is True or self.useMLEGlobally is True: - # use_mle = True - - # # Check JWT auth for request MLE - # if use_mle and self.authentication_type.lower() != GlobalLabelParameters.JWT.lower(): - # authenticationsdk.util.ExceptionAuth.validate_merchant_details_log(self.logger, - # GlobalLabelParameters.MLE_AUTH_ERROR, - # self.log_config) # Validate Response MLE configuration response_mle_configured = self.enableResponseMleGlobally @@ -652,12 +651,44 @@ def is_valid_boolean_string(self, value): return value.strip().lower() in ("true", "false") return False + # Expected value (in config / cybs.json): + # "mapToControlMLEonAPI": { + # "apiFunctionName1": "true::true", # request MLE = true, response MLE = true + # "apiFunctionName2": "false::false", # request MLE = false, response MLE = false + # "apiFunctionName3": "true::false", # request MLE = true, response MLE = false + # "apiFunctionName4": "false::true", # request MLE = false, response MLE = true + # "apiFunctionName5": "true", # request MLE = true, response uses global flag + # "apiFunctionName6": "false", # request MLE = false, response uses global flag + # "apiFunctionName7": "::true", # response MLE = true, request uses global flag + # "apiFunctionName8": "true::", # request MLE = true, response uses global flag + # } + # IMPORTANT: + # Use STRING values when you need to control both request & response (use '::' separator). + # A bare boolean True/False (or "true"/"false") only applies to request MLE. def validate_map_to_control_mle_on_api_values(self, map_to_control_mle_on_api): """ Validates the map values for MLE control API configuration. - Allowed formats: "true::true", "false::false", "::true", "true::", "::false", "false::", "true", "false" - + Allowed formats (case‑insensitive): + "true::true" - request MLE true, response MLE true + "false::false" - request MLE false, response MLE false + "true::false" - request MLE true, response MLE false + "false::true" - request MLE false, response MLE true + "true" - request MLE true, response uses global flag + "false" - request MLE false, response uses global flag + "::true" - response MLE true, request uses global flag + "true::" - request MLE true, response uses global flag + + Invalid: + "::" (both empty) + "true::true::false" (multiple separators) + "" (empty string) + "invalid::true" / "true::invalid" + + Notes: + - A Python boolean (True / False) is treated the same as "true"/"false" (request only). + - Missing side around '::' -> that side falls back to global enable/disable flags. + Args: map_to_control_mle_on_api (dict): The map to validate diff --git a/authenticationsdk/util/Cache.py b/authenticationsdk/util/Cache.py index 1485008e..b8a73b69 100644 --- a/authenticationsdk/util/Cache.py +++ b/authenticationsdk/util/Cache.py @@ -142,45 +142,35 @@ def setup_mle_cache(self, merchant_config, cache_key, file_path): # Handle Response MLE Private Key if cache_key.endswith(GlobalLabelParameters.MLE_CACHE_KEY_IDENTIFIER_FOR_RESPONSE_PRIVATE_KEY): - try: + try: file_extension = os.path.splitext(file_path)[1].lower() - - # Handle different file formats - if file_extension in ['.p12', '.pfx']: - # PKCS#12 format - with open(file_path, 'rb') as f: - p12_data = f.read() - - password_bytes = merchant_config.responseMlePrivateKeyFilePassword.encode('utf-8') if merchant_config.responseMlePrivateKeyFilePassword else None - private_key, _, _ = pkcs12.load_key_and_certificates( - p12_data, password_bytes, default_backend() + password = merchant_config.responseMlePrivateKeyFilePassword + + if file_extension in ('.p12', '.pfx'): + private_key, _certs = CertificateUtility.fetch_certificate_collection_from_p12_file( + file_path, + password ) - elif file_extension in ['.pem', '.key', '.p8']: - # PEM format - with open(file_path, 'rb') as f: - pem_data = f.read() - - password_bytes = merchant_config.responseMlePrivateKeyFilePassword.encode('utf-8') if merchant_config.responseMlePrivateKeyFilePassword else None - private_key = load_pem_private_key( - pem_data, password=password_bytes, backend=default_backend() + elif file_extension in ('.pem', '.key', '.p8'): + private_key = CertificateUtility.load_private_key_from_pem( + file_path, + password ) else: raise ValueError(f"Unsupported file format: {file_extension}") - - # Save to cache (thread-safe) + cert_info = CertInfo( - None, # No certificate for private key + None, # No certificate for standalone private key os.path.getmtime(file_path), private_key ) with self._mle_cache_lock: self.mlecache[cache_key] = cert_info - return except Exception as e: - logger.error(f"Error loading Response MLE private key: {str(e)}") - raise ValueError(f"Error loading Response MLE private key: {str(e)}") - + logger.error(f"Error loading Response MLE private key: {e}") + raise ValueError(f"Error loading Response MLE private key: {e}") + # Handle PEM certificate case if cache_key.endswith(GlobalLabelParameters.MLE_CACHE_IDENTIFIER_FOR_CONFIG_CERT): certificates = CertificateUtility.load_certificates_from_pem_file(file_path) @@ -229,17 +219,16 @@ def get_mle_response_private_key(self, merchant_config): # Check if key exists in cache cert_info = self.mlecache.get(cache_key) - try: - file_timestamp = os.path.getmtime(file_path) - + file_timestamp = os.path.getmtime(file_path) # If not in cache or file was modified, load it - if cert_info is None or cert_info.timestamp != file_timestamp: - self.setup_mle_cache(merchant_config, cache_key, file_path) - cert_info = self.mlecache.get(cache_key) + if cert_info is None or cert_info.timestamp != file_timestamp: + self.setup_mle_cache(merchant_config, cache_key, file_path) + cert_info = self.mlecache.get(cache_key) - return cert_info.private_key if cert_info else None + return cert_info.private_key if cert_info else None except Exception as e: if FileCache.logger: FileCache.logger.error(f"Error getting Response MLE private key: {str(e)}") raise ValueError(f"Error getting Response MLE private key: {str(e)}") + diff --git a/authenticationsdk/util/CertificateUtility.py b/authenticationsdk/util/CertificateUtility.py index c2dbb5ca..c0ebab42 100644 --- a/authenticationsdk/util/CertificateUtility.py +++ b/authenticationsdk/util/CertificateUtility.py @@ -7,7 +7,7 @@ from authenticationsdk.util.GlobalLabelParameters import GlobalLabelParameters import CyberSource.logging.log_factory as LogFactory from CyberSource.logging.log_configuration import LogConfiguration -from cryptography.hazmat.primitives.serialization import pkcs12 +from cryptography.hazmat.primitives.serialization import pkcs12, load_pem_private_key, load_der_private_key class CertificateUtility: logger = None @@ -129,3 +129,18 @@ def fetch_certificate_collection_from_p12_file(p12_file_path, key_password): if additional_certs is not None: certs.extend(additional_certs) return private_key, certs + + @staticmethod + def load_private_key_from_pem(pem_file_path, password=None): + """ + Load a private key from a PEM/PKCS#8 file (.pem/.key/.p8). + """ + if not os.path.exists(pem_file_path): + raise ValueError(f"PEM private key file not found: {pem_file_path}") + with open(pem_file_path, "rb") as f: + data = f.read() + pwd_bytes = password.encode("utf-8") if password else None + try: + return load_pem_private_key(data, password=pwd_bytes, backend=default_backend()) + except Exception: + raise ValueError(f"Failed to load private key from {pem_file_path}") diff --git a/authenticationsdk/util/GlobalLabelParameters.py b/authenticationsdk/util/GlobalLabelParameters.py index 4aeb319a..4bc22f67 100644 --- a/authenticationsdk/util/GlobalLabelParameters.py +++ b/authenticationsdk/util/GlobalLabelParameters.py @@ -43,8 +43,8 @@ class GlobalLabelParameters: KEY_ID = "keyid=\"" LOG_FILE_NAME_DEFAULT = "cybs" OLD_RUN_ENVIRONMENT_CONSTANTS = ["CYBERSOURCE.ENVIRONMENT.SANDBOX", "CYBERSOURCE.ENVIRONMENT.PRODUCTION", "CYBERSOURCE.IN.ENVIRONMENT.SANDBOX", "CYBERSOURCE.IN.ENVIRONMENT.PRODUCTION"] - HIDE_MERCHANT_CONFIG_PROPS = "merchantid,merchant_secretkey,merchant_keyid,key_alias,key_password" PROXY_PREFIX = "https" + HIDE_MERCHANT_CONFIG_PROPS = "merchantid,merchant_secretkey,merchant_keyid,key_alias,key_password,responseMlePrivateKeyFilePath,responseMlePrivateKeyFilePassword,responseMlePrivateKey" FILE_NOT_FOUND = "File not found. Check path/filename entered. Entered path/filename : " SYSTEM_ERROR = "System error encountered while accessing file : " AUTH_ERROR = "Check Authentication Type (HTTP_Signature/JWT) in cybs.json." diff --git a/authenticationsdk/util/MLEUtility.py b/authenticationsdk/util/MLEUtility.py index 7ad4fb7c..bd06af1b 100644 --- a/authenticationsdk/util/MLEUtility.py +++ b/authenticationsdk/util/MLEUtility.py @@ -11,6 +11,7 @@ from authenticationsdk.util.GlobalLabelParameters import GlobalLabelParameters import CyberSource.logging.log_factory as LogFactory from CyberSource.utilities.JWEResponse.JWEUtility import JWEUtility +from authenticationsdk.util.Utility import to_jwk_private_key class MLEUtility: logger = None @@ -134,7 +135,6 @@ def check_is_mle_encrypted_response(response_body): try: response_json = json.loads(response_body) - # Check if the JSON has exactly one key named "encryptedResponse" if len(response_json) != 1: return False @@ -165,7 +165,7 @@ def decrypt_mle_response_payload(merchant_config, mle_response_body): try: # Get private key for decryption private_key = MLEUtility._get_mle_response_private_key(merchant_config) - + private_key_jwk = to_jwk_private_key(private_key) # Extract the JWE token jwe_response_token = MLEUtility._get_response_mle_token(mle_response_body) @@ -178,7 +178,7 @@ def decrypt_mle_response_payload(merchant_config, mle_response_body): MLEUtility.logger.debug(f"LOG_NETWORK_RESPONSE_BEFORE_MLE_DECRYPTION: {mle_response_body}") decrypted_response = JWEUtility.decrypt_jwe_response_using_private_key( - private_key, jwe_response_token + private_key_jwk, jwe_response_token ) if MLEUtility.logger: diff --git a/authenticationsdk/util/Utility.py b/authenticationsdk/util/Utility.py index 878d8ba4..89d921ed 100644 --- a/authenticationsdk/util/Utility.py +++ b/authenticationsdk/util/Utility.py @@ -1,5 +1,7 @@ import json import re +from cryptography.hazmat.primitives import serialization +from jwcrypto import jwk def get_response_code_message(response): switcher = { @@ -46,3 +48,21 @@ def process_body(body): body = body.replace("productSku", "productSKU") body = body.replace("secCode", "SECCode") return body + +def to_jwk_private_key(private_key): + """ + Ensure the provided private_key is a jwcrypto.jwk.JWK instance. + Accepts a jwk.JWK or a cryptography private key object. + """ + if private_key is None: + raise ValueError("Private key is None") + if isinstance(private_key, jwk.JWK): + return private_key + if hasattr(private_key, "private_bytes"): + pem = private_key.private_bytes( + serialization.Encoding.PEM, + serialization.PrivateFormat.PKCS8, + serialization.NoEncryption() + ) + return jwk.JWK.from_pem(pem) + raise ValueError("Unsupported private key type for JWK conversion") From c93de8fd43f1ad10e3c9d12f1f43e1bd045be518 Mon Sep 17 00:00:00 2001 From: mahmishr Date: Wed, 17 Sep 2025 14:22:54 +0530 Subject: [PATCH 08/12] specific error handling for decrypt fail in pem --- authenticationsdk/core/MerchantConfiguration.py | 3 +++ authenticationsdk/util/CertificateUtility.py | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/authenticationsdk/core/MerchantConfiguration.py b/authenticationsdk/core/MerchantConfiguration.py index b654073e..b43c9b84 100644 --- a/authenticationsdk/core/MerchantConfiguration.py +++ b/authenticationsdk/core/MerchantConfiguration.py @@ -745,6 +745,9 @@ def set_mapToControlMLEonAPI(self, value): raise ValueError("mapToControlMLEonAPI must be a dictionary") # Check map value types - must be string or boolean + for key, val in map_to_control_mle_on_api.items(): + if not isinstance(val, (str, bool)): + raise ValueError(f"mapToControlMLEonAPI values must be string or boolean.") # Validate the map values self.validate_map_to_control_mle_on_api_values(map_to_control_mle_on_api) diff --git a/authenticationsdk/util/CertificateUtility.py b/authenticationsdk/util/CertificateUtility.py index c0ebab42..174f08ce 100644 --- a/authenticationsdk/util/CertificateUtility.py +++ b/authenticationsdk/util/CertificateUtility.py @@ -142,5 +142,10 @@ def load_private_key_from_pem(pem_file_path, password=None): pwd_bytes = password.encode("utf-8") if password else None try: return load_pem_private_key(data, password=pwd_bytes, backend=default_backend()) + except ValueError as ve: + msg = str(ve).lower() + if 'bad decrypt' in msg or 'incorrect password' in msg: + raise ValueError("Incorrect password for encrypted private key") + raise except Exception: raise ValueError(f"Failed to load private key from {pem_file_path}") From 8e6b689e044244751fe01393c6efe47aeca7c169 Mon Sep 17 00:00:00 2001 From: mahmishr Date: Tue, 23 Sep 2025 09:56:17 +0530 Subject: [PATCH 09/12] checkmarx fixes --- CyberSource/api_client.py | 3 +-- authenticationsdk/core/MerchantConfiguration.py | 2 +- authenticationsdk/util/Cache.py | 4 ++-- authenticationsdk/util/MLEUtility.py | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/CyberSource/api_client.py b/CyberSource/api_client.py index 8edfe8b3..a1ae180f 100644 --- a/CyberSource/api_client.py +++ b/CyberSource/api_client.py @@ -328,8 +328,7 @@ def __call_api(self, resource_path, method, if (hasattr(self, "logger") and hasattr(self.mconfig, "log_config") and self.mconfig.log_config.enable_log): - self.logger.error(f"[MLE] Failed to decrypt response resource_path={resource_path} " - f"error={type(e).__name__}: {e}") + self.logger.error("[MLE] Failed to decrypt response.") raise ApiException(status=500, reason=f"MLE response decryption failed: {e}") diff --git a/authenticationsdk/core/MerchantConfiguration.py b/authenticationsdk/core/MerchantConfiguration.py index 9f0bf1a3..669a3bb2 100644 --- a/authenticationsdk/core/MerchantConfiguration.py +++ b/authenticationsdk/core/MerchantConfiguration.py @@ -755,5 +755,5 @@ def set_mapToControlMLEonAPI(self, value): # Set the map self.mapToControlMLEonAPI = map_to_control_mle_on_api except Exception as e: - self.logger.error(f"Unable to initialize MLE control Map from config: {str(e)}") + self.logger.error(f"Unable to initialize MLE control Map from config") raise ValueError(f"Unable to initialize MLE control Map from config: {str(e)}") diff --git a/authenticationsdk/util/Cache.py b/authenticationsdk/util/Cache.py index b8a73b69..6e228e59 100644 --- a/authenticationsdk/util/Cache.py +++ b/authenticationsdk/util/Cache.py @@ -168,7 +168,7 @@ def setup_mle_cache(self, merchant_config, cache_key, file_path): self.mlecache[cache_key] = cert_info return except Exception as e: - logger.error(f"Error loading Response MLE private key: {e}") + logger.error("Error loading Response MLE private key") raise ValueError(f"Error loading Response MLE private key: {e}") # Handle PEM certificate case @@ -229,6 +229,6 @@ def get_mle_response_private_key(self, merchant_config): return cert_info.private_key if cert_info else None except Exception as e: if FileCache.logger: - FileCache.logger.error(f"Error getting Response MLE private key: {str(e)}") + FileCache.logger.error(f"Error getting Response MLE private key") raise ValueError(f"Error getting Response MLE private key: {str(e)}") diff --git a/authenticationsdk/util/MLEUtility.py b/authenticationsdk/util/MLEUtility.py index 2f6a7662..6c72af75 100644 --- a/authenticationsdk/util/MLEUtility.py +++ b/authenticationsdk/util/MLEUtility.py @@ -203,7 +203,7 @@ def _get_response_mle_token(mle_response_body): return response_json.get("encryptedResponse") except Exception as e: if MLEUtility.logger: - MLEUtility.logger.error(f"Failed to extract Response MLE token: {str(e)}") + MLEUtility.logger.error("Failed to extract response MLE token from response body.") return None @staticmethod From 7c7afc009bc2d1229ce61c145ea1251f99ec89a6 Mon Sep 17 00:00:00 2001 From: mahmishr Date: Tue, 23 Sep 2025 14:59:08 +0530 Subject: [PATCH 10/12] mustache update --- CyberSource/api_client.py | 2 +- generator/cybersource-python-template/api.mustache | 4 +--- generator/cybersource-python-template/api_client.mustache | 5 ++--- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/CyberSource/api_client.py b/CyberSource/api_client.py index a1ae180f..c03bf28d 100644 --- a/CyberSource/api_client.py +++ b/CyberSource/api_client.py @@ -322,7 +322,7 @@ def __call_api(self, resource_path, method, try: if MLEUtility.check_is_mle_encrypted_response(response_data.data): decrypted_data = MLEUtility.decrypt_mle_response_payload(self.mconfig, response_data.data) - response_data.data = decrypted_data #check this + response_data.data = decrypted_data except Exception as e: # Log the error but continue with the response if (hasattr(self, "logger") and diff --git a/generator/cybersource-python-template/api.mustache b/generator/cybersource-python-template/api.mustache index b5b8c3ca..b9e463b2 100644 --- a/generator/cybersource-python-template/api.mustache +++ b/generator/cybersource-python-template/api.mustache @@ -214,9 +214,7 @@ class {{classname}}(object): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "{{operationId}},{{operationId}}_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) - isResponseMLEforApi = False - if MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "{{operationId}},{{operationId}}_with_http_info"): - isResponseMLEforApi = True + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "{{operationId}},{{operationId}}_with_http_info") # Authentication setting auth_settings = [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}] diff --git a/generator/cybersource-python-template/api_client.mustache b/generator/cybersource-python-template/api_client.mustache index ad2b84c1..add7245b 100644 --- a/generator/cybersource-python-template/api_client.mustache +++ b/generator/cybersource-python-template/api_client.mustache @@ -311,7 +311,6 @@ class ApiClient(object): _request_timeout=_request_timeout) if hasattr(self, 'mconfig'): - if isResponseMLEforApi: try: if MLEUtility.check_is_mle_encrypted_response(response_data.data): decrypted_data = MLEUtility.decrypt_mle_response_payload(self.mconfig, response_data.data) @@ -320,8 +319,8 @@ class ApiClient(object): if (hasattr(self, "logger") and hasattr(self.mconfig, "log_config") and self.mconfig.log_config.enable_log): - self.logger.error(f"[MLE] Failed to decrypt response resource_path={resource_path} " - f"error={type(e).__name__}: {e}") + self.logger.error("[MLE] Failed to decrypt response") + raise ApiException(status=500, reason=f"MLE response decryption failed: {e}") if self.download_file_path is None: self.last_response = response_data From 3593d0de2492216612928e33144a7ccda87ec677 Mon Sep 17 00:00:00 2001 From: mahmishr Date: Tue, 23 Sep 2025 15:13:58 +0530 Subject: [PATCH 11/12] auto gen code --- docs/PushFunds401Response.md | 13 - docs/PushFunds404Response.md | 13 - docs/PushFunds502Response.md | 14 - docs/PushFundsApi.md | 69 --- docs/PushFundsRequest.md | 17 - docs/Rbsv1plansClientReferenceInformation.md | 14 - docs/Rbsv1plansOrderInformation.md | 10 - ...Rbsv1plansOrderInformationAmountDetails.md | 12 - docs/Rbsv1plansPlanInformation.md | 15 - .../Rbsv1plansPlanInformationBillingCycles.md | 10 - docs/Rbsv1plansidPlanInformation.md | 15 - docs/Rbsv1plansidProcessingInformation.md | 10 - ...ngInformationSubscriptionBillingOptions.md | 10 - ...subscriptionsClientReferenceInformation.md | 15 - ...ptionsClientReferenceInformationPartner.md | 11 - docs/Rbsv1subscriptionsPaymentInformation.md | 10 - ...subscriptionsPaymentInformationCustomer.md | 10 - docs/Rbsv1subscriptionsPlanInformation.md | 11 - ...Rbsv1subscriptionsProcessingInformation.md | 11 - ...ocessingInformationAuthorizationOptions.md | 10 - ...nformationAuthorizationOptionsInitiator.md | 10 - ...sv1subscriptionsSubscriptionInformation.md | 15 - docs/Rbsv1subscriptionsidOrderInformation.md | 10 - ...riptionsidOrderInformationAmountDetails.md | 11 - docs/Rbsv1subscriptionsidPlanInformation.md | 10 - ...1subscriptionsidSubscriptionInformation.md | 13 - docs/RefreshPaymentStatusRequest.md | 13 - docs/RefundApi.md | 110 ----- docs/RefundCaptureRequest.md | 21 - docs/RefundPaymentRequest.md | 21 - docs/ReportDefinitionsApi.md | 114 ----- docs/ReportDownloadsApi.md | 60 --- docs/ReportSubscriptionsApi.md | 258 ----------- ...ortingV3ChargebackDetailsGet200Response.md | 13 - ...kDetailsGet200ResponseChargebackDetails.md | 32 -- ...tingV3ChargebackSummariesGet200Response.md | 13 - ...mariesGet200ResponseChargebackSummaries.md | 12 - ...ortingV3ConversionDetailsGet200Response.md | 13 - ...nDetailsGet200ResponseConversionDetails.md | 19 - ...gV3ConversionDetailsGet200ResponseNotes.md | 12 - ...hangeClearingLevelDetailsGet200Response.md | 12 - ...ResponseInterchangeClearingLevelDetails.md | 60 --- docs/ReportingV3NetFundingsGet200Response.md | 17 - ...ndingsGet200ResponseNetFundingSummaries.md | 17 - ...NetFundingsGet200ResponseTotalPurchases.md | 11 - ...ngV3NotificationofChangesGet200Response.md | 10 - ...ngesGet200ResponseNotificationOfChanges.md | 17 - ...ngV3PaymentBatchSummariesGet200Response.md | 12 - ...riesGet200ResponsePaymentBatchSummaries.md | 21 - ...ngV3PurchaseRefundDetailsGet200Response.md | 18 - ...fundDetailsGet200ResponseAuthorizations.md | 17 - ...tailsGet200ResponseFeeAndFundingDetails.md | 22 - ...rchaseRefundDetailsGet200ResponseOthers.md | 16 - ...fundDetailsGet200ResponseRequestDetails.md | 15 - ...DetailsGet200ResponseSettlementStatuses.md | 14 - ...eRefundDetailsGet200ResponseSettlements.md | 22 - ...ortingV3ReportDefinitionsGet200Response.md | 10 - ...initionsGet200ResponseReportDefinitions.md | 16 - ...ngV3ReportDefinitionsNameGet200Response.md | 17 - ...DefinitionsNameGet200ResponseAttributes.md | 16 - ...itionsNameGet200ResponseDefaultSettings.md | 17 - ...tingV3ReportSubscriptionsGet200Response.md | 10 - ...ubscriptionsGet200ResponseSubscriptions.md | 23 - docs/ReportingV3ReportsGet200Response.md | 10 - docs/ReportingV3ReportsGet200ResponseLink.md | 10 - ...ReportsGet200ResponseLinkReportDownload.md | 11 - ...eportsGet200ResponseReportSearchResults.md | 25 -- docs/ReportingV3ReportsIdGet200Response.md | 23 - ...portingV3RetrievalDetailsGet200Response.md | 13 - ...alDetailsGet200ResponseRetrievalDetails.md | 31 -- ...rtingV3RetrievalSummariesGet200Response.md | 13 - ...eportingv3ReportDownloadsGet400Response.md | 13 - ...gv3ReportDownloadsGet400ResponseDetails.md | 11 - docs/Reportingv3reportsReportFilters.md | 13 - docs/Reportingv3reportsReportPreferences.md | 11 - docs/ReportsApi.md | 174 -------- docs/Request.md | 11 - docs/ResourceNotFoundError.md | 11 - docs/RetrievalDetailsApi.md | 61 --- docs/RetrievalSummariesApi.md | 61 --- docs/ReversalApi.md | 108 ----- docs/RiskProducts.md | 12 - docs/RiskProductsDecisionManager.md | 11 - ...DecisionManagerConfigurationInformation.md | 11 - docs/RiskProductsFraudManagementEssentials.md | 11 - ...ementEssentialsConfigurationInformation.md | 10 - docs/RiskProductsPortfolioRiskControls.md | 11 - ...lioRiskControlsConfigurationInformation.md | 10 - ...sConfigurationInformationConfigurations.md | 10 - ...skV1AddressVerificationsPost201Response.md | 18 - ...1ResponseAddressVerificationInformation.md | 17 - ...seAddressVerificationInformationBarCode.md | 11 - ...sVerificationInformationStandardAddress.md | 20 - ...ationInformationStandardAddressAddress1.md | 11 - ...icationsPost201ResponseErrorInformation.md | 12 - ...kV1AuthenticationResultsPost201Response.md | 17 - ...sponseConsumerAuthenticationInformation.md | 40 -- ...skV1AuthenticationSetupsPost201Response.md | 16 - ...sponseConsumerAuthenticationInformation.md | 12 - ...onSetupsPost201ResponseErrorInformation.md | 12 - docs/RiskV1AuthenticationsPost201Response.md | 18 - ...icationsPost201ResponseErrorInformation.md | 12 - docs/RiskV1AuthenticationsPost400Response.md | 14 - docs/RiskV1AuthenticationsPost400Response1.md | 14 - docs/RiskV1DecisionsPost201Response.md | 21 - ...st201ResponseClientReferenceInformation.md | 12 - ...sponseConsumerAuthenticationInformation.md | 55 --- ...ecisionsPost201ResponseErrorInformation.md | 12 - ...ecisionsPost201ResponseOrderInformation.md | 10 - ...01ResponseOrderInformationAmountDetails.md | 10 - ...isionsPost201ResponsePaymentInformation.md | 14 - docs/RiskV1DecisionsPost400Response.md | 14 - docs/RiskV1DecisionsPost400Response1.md | 14 - ...xportComplianceInquiriesPost201Response.md | 18 - ...nquiriesPost201ResponseErrorInformation.md | 12 - docs/RiskV1UpdatePost201Response.md | 14 - ...kv1addressverificationsBuyerInformation.md | 10 - ...kv1addressverificationsOrderInformation.md | 12 - ...ressverificationsOrderInformationBillTo.md | 17 - ...sverificationsOrderInformationLineItems.md | 15 - ...ressverificationsOrderInformationShipTo.md | 17 - ...esultsConsumerAuthenticationInformation.md | 17 - ...1authenticationresultsDeviceInformation.md | 10 - ...v1authenticationresultsOrderInformation.md | 10 - ...ionresultsOrderInformationAmountDetails.md | 11 - ...authenticationresultsPaymentInformation.md | 13 - ...enticationresultsPaymentInformationCard.md | 13 - ...ationresultsPaymentInformationFluidData.md | 13 - ...nresultsPaymentInformationTokenizedCard.md | 14 - docs/Riskv1authenticationsBuyerInformation.md | 13 - .../Riskv1authenticationsDeviceInformation.md | 21 - docs/Riskv1authenticationsOrderInformation.md | 17 - ...nticationsOrderInformationAmountDetails.md | 11 - ...v1authenticationsOrderInformationBillTo.md | 20 - ...uthenticationsOrderInformationLineItems.md | 29 -- ...Riskv1authenticationsPaymentInformation.md | 13 - ...thenticationsPaymentInformationCustomer.md | 11 - ...icationsPaymentInformationTokenizedCard.md | 16 - docs/Riskv1authenticationsRiskInformation.md | 10 - .../Riskv1authenticationsTravelInformation.md | 12 - ...icationsetupsClientReferenceInformation.md | 13 - ...1authenticationsetupsPaymentInformation.md | 13 - ...henticationsetupsPaymentInformationCard.md | 13 - ...icationsetupsPaymentInformationCustomer.md | 10 - ...cationsetupsPaymentInformationFluidData.md | 13 - ...onsetupsPaymentInformationTokenizedCard.md | 14 - ...thenticationsetupsProcessingInformation.md | 11 - ...kv1authenticationsetupsTokenInformation.md | 11 - docs/Riskv1decisionsAcquirerInformation.md | 13 - docs/Riskv1decisionsBuyerInformation.md | 14 - ...skv1decisionsClientReferenceInformation.md | 13 - ...isionsClientReferenceInformationPartner.md | 11 - ...isionsConsumerAuthenticationInformation.md | 49 --- ...ticationInformationStrongAuthentication.md | 10 - docs/Riskv1decisionsDeviceInformation.md | 26 -- ...skv1decisionsMerchantDefinedInformation.md | 11 - docs/Riskv1decisionsMerchantInformation.md | 11 - ...nsMerchantInformationMerchantDescriptor.md | 11 - docs/Riskv1decisionsOrderInformation.md | 20 - ...1decisionsOrderInformationAmountDetails.md | 11 - docs/Riskv1decisionsOrderInformationBillTo.md | 19 - ...iskv1decisionsOrderInformationLineItems.md | 25 -- docs/Riskv1decisionsOrderInformationShipTo.md | 23 - ...ecisionsOrderInformationShippingDetails.md | 11 - docs/Riskv1decisionsPaymentInformation.md | 14 - docs/Riskv1decisionsPaymentInformationCard.md | 14 - ...ecisionsPaymentInformationTokenizedCard.md | 14 - docs/Riskv1decisionsProcessingInformation.md | 10 - docs/Riskv1decisionsProcessorInformation.md | 11 - .../Riskv1decisionsProcessorInformationAvs.md | 10 - ...onsProcessorInformationCardVerification.md | 10 - docs/Riskv1decisionsRiskInformation.md | 13 - docs/Riskv1decisionsTokenInformation.md | 10 - docs/Riskv1decisionsTravelInformation.md | 16 - docs/Riskv1decisionsTravelInformationLegs.md | 14 - ...kv1decisionsTravelInformationPassengers.md | 11 - ...v1decisionsidactionsDecisionInformation.md | 11 - ...decisionsidactionsProcessingInformation.md | 10 - ...Riskv1decisionsidmarkingRiskInformation.md | 10 - ...sidmarkingRiskInformationMarkingDetails.md | 13 - ...ortcomplianceinquiriesDeviceInformation.md | 11 - ...nceinquiriesExportComplianceInformation.md | 12 - ...portcomplianceinquiriesOrderInformation.md | 12 - ...mplianceinquiriesOrderInformationBillTo.md | 21 - ...einquiriesOrderInformationBillToCompany.md | 10 - ...ianceinquiriesOrderInformationLineItems.md | 17 - ...mplianceinquiriesOrderInformationShipTo.md | 12 - .../Riskv1liststypeentriesBuyerInformation.md | 10 - ...tstypeentriesClientReferenceInformation.md | 12 - ...Riskv1liststypeentriesDeviceInformation.md | 11 - .../Riskv1liststypeentriesOrderInformation.md | 13 - ...liststypeentriesOrderInformationAddress.md | 15 - ...1liststypeentriesOrderInformationBillTo.md | 20 - ...ststypeentriesOrderInformationLineItems.md | 10 - ...1liststypeentriesOrderInformationShipTo.md | 15 - ...iskv1liststypeentriesPaymentInformation.md | 11 - ...1liststypeentriesPaymentInformationBank.md | 13 - ...1liststypeentriesPaymentInformationCard.md | 12 - docs/Riskv1liststypeentriesRiskInformation.md | 10 - ...ypeentriesRiskInformationMarkingDetails.md | 13 - docs/SAConfig.md | 16 - docs/SAConfigCheckout.md | 12 - docs/SAConfigContactInformation.md | 13 - docs/SAConfigNotifications.md | 11 - ...onfigNotificationsCustomerNotifications.md | 16 - ...onfigNotificationsMerchantNotifications.md | 14 - docs/SAConfigPaymentMethods.md | 10 - docs/SAConfigPaymentTypes.md | 10 - docs/SAConfigPaymentTypesCardTypes.md | 13 - docs/SAConfigPaymentTypesCardTypesDiscover.md | 16 - docs/SAConfigService.md | 16 - docs/SaveAsymEgressKey.md | 12 - docs/SaveSymEgressKey.md | 12 - docs/SearchRequest.md | 13 - docs/SearchTransactionsApi.md | 106 ----- docs/SecureFileShareApi.md | 113 ----- docs/ShippingAddressListForCustomer.md | 15 - .../ShippingAddressListForCustomerEmbedded.md | 10 - docs/ShippingAddressListForCustomerLinks.md | 14 - ...hippingAddressListForCustomerLinksFirst.md | 10 - ...ShippingAddressListForCustomerLinksLast.md | 10 - ...ShippingAddressListForCustomerLinksNext.md | 10 - ...ShippingAddressListForCustomerLinksPrev.md | 10 - ...ShippingAddressListForCustomerLinksSelf.md | 10 - docs/SubscriptionsApi.md | 406 ------------------ docs/SubscriptionsFollowOnsApi.md | 108 ----- docs/SuspendSubscriptionResponse.md | 14 - ...criptionResponseSubscriptionInformation.md | 11 - docs/TaxRequest.md | 14 - docs/TaxesApi.md | 108 ----- docs/TmsAuthorizationOptions.md | 10 - docs/TmsAuthorizationOptionsInitiator.md | 10 - ...nsInitiatorMerchantInitiatedTransaction.md | 11 - docs/TmsBinLookup.md | 11 - docs/TmsBinLookupIssuerInformation.md | 14 - docs/TmsBinLookupPaymentAccountInformation.md | 12 - ...sBinLookupPaymentAccountInformationCard.md | 15 - ...okupPaymentAccountInformationCardBrands.md | 11 - ...LookupPaymentAccountInformationFeatures.md | 28 -- ...nLookupPaymentAccountInformationNetwork.md | 10 - docs/TmsBusinessInformation.md | 16 - docs/TmsBusinessInformationAcquirer.md | 11 - docs/TmsBusinessInformationAddress.md | 11 - docs/TmsCardArt.md | 14 - docs/TmsCardArtBrandLogoAsset.md | 11 - docs/TmsCardArtBrandLogoAssetLinks.md | 10 - docs/TmsCardArtBrandLogoAssetLinksSelf.md | 10 - docs/TmsCardArtCombinedAsset.md | 11 - docs/TmsCardArtCombinedAssetLinks.md | 10 - docs/TmsCardArtCombinedAssetLinksSelf.md | 10 - docs/TmsCardArtIconAsset.md | 11 - docs/TmsCardArtIconAssetLinks.md | 10 - docs/TmsCardArtIconAssetLinksSelf.md | 10 - docs/TmsCardArtIssuerLogoAsset.md | 11 - docs/TmsCardArtIssuerLogoAssetLinks.md | 10 - docs/TmsCardArtIssuerLogoAssetLinksSelf.md | 10 - docs/TmsEmbeddedInstrumentIdentifier.md | 23 - ...EmbeddedInstrumentIdentifierBankAccount.md | 11 - docs/TmsEmbeddedInstrumentIdentifierBillTo.md | 15 - docs/TmsEmbeddedInstrumentIdentifierCard.md | 13 - ...TmsEmbeddedInstrumentIdentifierEmbedded.md | 10 - docs/TmsEmbeddedInstrumentIdentifierIssuer.md | 10 - docs/TmsEmbeddedInstrumentIdentifierLinks.md | 11 - ...rumentIdentifierLinksPaymentInstruments.md | 10 - ...msEmbeddedInstrumentIdentifierLinksSelf.md | 10 - ...TmsEmbeddedInstrumentIdentifierMetadata.md | 10 - ...strumentIdentifierProcessingInformation.md | 10 - docs/TmsNetworkTokenServices.md | 15 - ...okenServicesAmericanExpressTokenService.md | 13 - ...vicesMastercardDigitalEnablementService.md | 12 - docs/TmsNetworkTokenServicesNotifications.md | 10 - ...sNetworkTokenServicesPaymentCredentials.md | 10 - ...orkTokenServicesSynchronousProvisioning.md | 10 - ...TmsNetworkTokenServicesVisaTokenService.md | 13 - docs/TmsNullify.md | 12 - docs/TmsPaymentInstrumentProcessingInfo.md | 11 - ...rumentProcessingInfoBankTransferOptions.md | 10 - docs/TmsSensitivePrivileges.md | 10 - docs/TmsTokenFormats.md | 13 - docs/Tmsv2TokenizedCard.md | 32 -- docs/Tmsv2TokenizedCardCard.md | 14 - docs/Tmsv2TokenizedCardLinks.md | 10 - docs/Tmsv2TokenizedCardLinksSelf.md | 10 - docs/Tmsv2TokenizedCardMetadata.md | 11 - docs/Tmsv2TokenizedCardMetadataIssuer.md | 12 - docs/Tmsv2TokenizedCardPasscode.md | 10 - docs/Tmsv2customersBuyerInformation.md | 11 - ...msv2customersClientReferenceInformation.md | 10 - .../Tmsv2customersDefaultPaymentInstrument.md | 10 - docs/Tmsv2customersDefaultShippingAddress.md | 10 - docs/Tmsv2customersEmbedded.md | 11 - ...stomersEmbeddedDefaultPaymentInstrument.md | 24 -- ...ddedDefaultPaymentInstrumentBankAccount.md | 10 - ...sEmbeddedDefaultPaymentInstrumentBillTo.md | 20 - ...efaultPaymentInstrumentBuyerInformation.md | 13 - ...ymentInstrumentBuyerInformationIssuedBy.md | 10 - ...tBuyerInformationPersonalIdentification.md | 12 - ...ersEmbeddedDefaultPaymentInstrumentCard.md | 18 - ...ymentInstrumentCardTokenizedInformation.md | 11 - ...mbeddedDefaultPaymentInstrumentEmbedded.md | 10 - ...ltPaymentInstrumentInstrumentIdentifier.md | 10 - ...rsEmbeddedDefaultPaymentInstrumentLinks.md | 11 - ...beddedDefaultPaymentInstrumentLinksSelf.md | 10 - ...ultPaymentInstrumentMerchantInformation.md | 10 - ...ntMerchantInformationMerchantDescriptor.md | 10 - ...mbeddedDefaultPaymentInstrumentMetadata.md | 10 - ...customersEmbeddedDefaultShippingAddress.md | 14 - ...mersEmbeddedDefaultShippingAddressLinks.md | 11 - ...ddedDefaultShippingAddressLinksCustomer.md | 10 - ...EmbeddedDefaultShippingAddressLinksSelf.md | 10 - ...sEmbeddedDefaultShippingAddressMetadata.md | 10 - ...ersEmbeddedDefaultShippingAddressShipTo.md | 20 - docs/Tmsv2customersLinks.md | 12 - docs/Tmsv2customersLinksPaymentInstruments.md | 10 - docs/Tmsv2customersLinksSelf.md | 10 - docs/Tmsv2customersLinksShippingAddress.md | 10 - ...msv2customersMerchantDefinedInformation.md | 11 - docs/Tmsv2customersMetadata.md | 10 - docs/Tmsv2customersObjectInformation.md | 11 - docs/TokenApi.md | 114 ----- docs/TokenPermissions.md | 13 - docs/TokenizedCardApi.md | 160 ------- docs/TokenizedcardRequest.md | 32 -- docs/TransactionBatchesApi.md | 208 --------- docs/TransactionDetailsApi.md | 57 --- docs/TransientTokenDataApi.md | 105 ----- docs/TssV2GetEmvTags200Response.md | 10 - ...etEmvTags200ResponseEmvTagBreakdownList.md | 11 - docs/TssV2PostEmvTags200Response.md | 10 - ...stEmvTags200ResponseEmvTagBreakdownList.md | 14 - ...PostEmvTags200ResponseParsedEMVTagsList.md | 12 - docs/TssV2TransactionsGet200Response.md | 40 -- ...onsGet200ResponseApplicationInformation.md | 14 - ...ponseApplicationInformationApplications.md | 17 - ...ionsGet200ResponseBankAccountValidation.md | 12 - ...nsactionsGet200ResponseBuyerInformation.md | 11 - ...et200ResponseClientReferenceInformation.md | 15 - ...sponseClientReferenceInformationPartner.md | 11 - ...sponseConsumerAuthenticationInformation.md | 14 - ...ticationInformationStrongAuthentication.md | 14 - ...sactionsGet200ResponseDeviceInformation.md | 12 - ...nsactionsGet200ResponseErrorInformation.md | 12 - ...nsGet200ResponseFraudMarkingInformation.md | 10 - ...onsGet200ResponseInstallmentInformation.md | 11 - docs/TssV2TransactionsGet200ResponseLinks.md | 11 - ...ctionsGet200ResponseMerchantInformation.md | 10 - ...seMerchantInformationMerchantDescriptor.md | 10 - ...nsactionsGet200ResponseOrderInformation.md | 15 - ...00ResponseOrderInformationAmountDetails.md | 16 - ...onsGet200ResponseOrderInformationBillTo.md | 23 - ...0ResponseOrderInformationInvoiceDetails.md | 10 - ...Get200ResponseOrderInformationLineItems.md | 16 - ...onsGet200ResponseOrderInformationShipTo.md | 19 - ...ResponseOrderInformationShippingDetails.md | 11 - ...actionsGet200ResponsePaymentInformation.md | 23 - ...sponsePaymentInformationAccountFeatures.md | 12 - ...onsGet200ResponsePaymentInformationBank.md | 16 - ...00ResponsePaymentInformationBankAccount.md | 16 - ...00ResponsePaymentInformationBankMandate.md | 12 - ...sGet200ResponsePaymentInformationBrands.md | 11 - ...onsGet200ResponsePaymentInformationCard.md | 21 - ...et200ResponsePaymentInformationCustomer.md | 11 - ...et200ResponsePaymentInformationFeatures.md | 16 - ...t200ResponsePaymentInformationFluidData.md | 10 - ...ePaymentInformationInstrumentIdentifier.md | 10 - ...Get200ResponsePaymentInformationInvoice.md | 12 - ...onsePaymentInformationIssuerInformation.md | 14 - ...Get200ResponsePaymentInformationNetwork.md | 10 - ...00ResponsePaymentInformationPaymentType.md | 12 - ...TransactionsGet200ResponsePayoutOptions.md | 10 - ...onsGet200ResponsePointOfSaleInformation.md | 14 - ...ionsGet200ResponseProcessingInformation.md | 21 - ...ocessingInformationAuthorizationOptions.md | 14 - ...nformationAuthorizationOptionsInitiator.md | 13 - ...rocessingInformationBankTransferOptions.md | 10 - ...onseProcessingInformationCaptureOptions.md | 11 - ...rocessingInformationJapanPaymentOptions.md | 18 - ...tionsGet200ResponseProcessorInformation.md | 26 -- ...nformationElectronicVerificationResults.md | 19 - ...ocessorInformationMultiProcessorRouting.md | 13 - ...00ResponseProcessorInformationProcessor.md | 10 - ...t200ResponseRecurringPaymentInformation.md | 10 - ...ansactionsGet200ResponseRiskInformation.md | 15 - ...onsGet200ResponseRiskInformationProfile.md | 11 - ...tionsGet200ResponseRiskInformationRules.md | 11 - ...tionsGet200ResponseRiskInformationScore.md | 11 - ...sactionsGet200ResponseSenderInformation.md | 10 - ...nsactionsGet200ResponseTokenInformation.md | 15 - docs/TssV2TransactionsPost201Response.md | 22 - ...ssV2TransactionsPost201ResponseEmbedded.md | 10 - ...1ResponseEmbeddedApplicationInformation.md | 14 - ...eddedApplicationInformationApplications.md | 18 - ...ponseEmbeddedClientReferenceInformation.md | 13 - ...beddedClientReferenceInformationPartner.md | 10 - ...beddedConsumerAuthenticationInformation.md | 12 - ...Post201ResponseEmbeddedErrorInformation.md | 10 - ...ransactionsPost201ResponseEmbeddedLinks.md | 10 - ...t201ResponseEmbeddedMerchantInformation.md | 10 - ...Post201ResponseEmbeddedOrderInformation.md | 12 - ...1ResponseEmbeddedOrderInformationBillTo.md | 15 - ...1ResponseEmbeddedOrderInformationShipTo.md | 14 - ...st201ResponseEmbeddedPaymentInformation.md | 13 - ...1ResponseEmbeddedPaymentInformationBank.md | 10 - ...seEmbeddedPaymentInformationBankAccount.md | 11 - ...1ResponseEmbeddedPaymentInformationCard.md | 12 - ...seEmbeddedPaymentInformationPaymentType.md | 11 - ...1ResponseEmbeddedPointOfSaleInformation.md | 14 - ...seEmbeddedPointOfSaleInformationPartner.md | 10 - ...01ResponseEmbeddedProcessingInformation.md | 13 - ...201ResponseEmbeddedProcessorInformation.md | 14 - ...sPost201ResponseEmbeddedRiskInformation.md | 10 - ...esponseEmbeddedRiskInformationProviders.md | 10 - ...ddedRiskInformationProvidersFingerprint.md | 12 - ...201ResponseEmbeddedTransactionSummaries.md | 29 -- ...transactionsemvTagDetailsEmvDetailsList.md | 11 - docs/UmsV1UsersGet200Response.md | 10 - ...V1UsersGet200ResponseAccountInformation.md | 17 - ...V1UsersGet200ResponseContactInformation.md | 13 - ...rsGet200ResponseOrganizationInformation.md | 10 - docs/UmsV1UsersGet200ResponseUsers.md | 13 - docs/UnauthorizedClientError.md | 11 - docs/UnifiedCheckoutCaptureContextApi.md | 57 --- docs/UpdateInvoiceRequest.md | 13 - docs/UpdateOrderRequest.md | 14 - docs/UpdatePaymentLinkRequest.md | 14 - docs/UpdatePlanRequest.md | 12 - docs/UpdatePlanResponse.md | 14 - docs/UpdatePlanResponsePlanInformation.md | 11 - docs/UpdateStatus.md | 10 - docs/UpdateSubscription.md | 14 - docs/UpdateSubscriptionResponse.md | 14 - docs/UpdateWebhook.md | 17 - docs/Upv1capturecontextsCaptureMandate.md | 19 - docs/Upv1capturecontextsCompleteMandate.md | 12 - docs/Upv1capturecontextsOrderInformation.md | 12 - ...recontextsOrderInformationAmountDetails.md | 11 - ...v1capturecontextsOrderInformationBillTo.md | 28 -- ...recontextsOrderInformationBillToCompany.md | 20 - ...v1capturecontextsOrderInformationShipTo.md | 21 - docs/UserManagementApi.md | 63 --- docs/UserManagementSearchApi.md | 57 --- docs/V1FileDetailsGet200Response.md | 11 - .../V1FileDetailsGet200ResponseFileDetails.md | 16 - docs/V1FileDetailsGet200ResponseLinks.md | 11 - docs/V1FileDetailsGet200ResponseLinksFiles.md | 12 - docs/V1FileDetailsGet200ResponseLinksSelf.md | 11 - docs/VTConfig.md | 11 - docs/VTConfigCardNotPresent.md | 11 - ...gCardNotPresentGlobalPaymentInformation.md | 12 - ...lobalPaymentInformationBasicInformation.md | 18 - ...entInformationMerchantDefinedDataFields.md | 34 -- ...balPaymentInformationPaymentInformation.md | 22 - ...TConfigCardNotPresentReceiptInformation.md | 12 - ...otPresentReceiptInformationEmailReceipt.md | 10 - ...gCardNotPresentReceiptInformationHeader.md | 10 - ...esentReceiptInformationOrderInformation.md | 11 - docs/ValidateExportComplianceRequest.md | 14 - docs/ValidateRequest.md | 16 - docs/ValueAddedServicesProducts.md | 12 - docs/VasV2PaymentsPost201Response.md | 16 - docs/VasV2PaymentsPost201ResponseLinks.md | 10 - ...PaymentsPost201ResponseOrderInformation.md | 15 - ...201ResponseOrderInformationJurisdiction.md | 18 - ...ost201ResponseOrderInformationLineItems.md | 14 - ...st201ResponseOrderInformationTaxDetails.md | 11 - ...V2PaymentsPost201ResponseTaxInformation.md | 11 - docs/VasV2PaymentsPost400Response.md | 14 - docs/VasV2TaxVoid200Response.md | 14 - ...asV2TaxVoid200ResponseVoidAmountDetails.md | 11 - docs/VasV2TaxVoidsPost400Response.md | 14 - docs/Vasv2taxBuyerInformation.md | 10 - docs/Vasv2taxClientReferenceInformation.md | 12 - docs/Vasv2taxMerchantInformation.md | 10 - docs/Vasv2taxOrderInformation.md | 17 - docs/Vasv2taxOrderInformationBillTo.md | 15 - .../Vasv2taxOrderInformationInvoiceDetails.md | 10 - docs/Vasv2taxOrderInformationLineItems.md | 23 - ...Vasv2taxOrderInformationOrderAcceptance.md | 13 - docs/Vasv2taxOrderInformationOrderOrigin.md | 13 - docs/Vasv2taxOrderInformationShipTo.md | 16 - ...Vasv2taxOrderInformationShippingDetails.md | 13 - docs/Vasv2taxTaxInformation.md | 16 - docs/Vasv2taxidClientReferenceInformation.md | 12 - ...2taxidClientReferenceInformationPartner.md | 11 - docs/VerificationApi.md | 106 ----- docs/VerifyCustomerAddressRequest.md | 12 - docs/VoidApi.md | 261 ----------- docs/VoidCaptureRequest.md | 15 - docs/VoidCreditRequest.md | 15 - docs/VoidPaymentRequest.md | 15 - docs/VoidRefundRequest.md | 15 - docs/VoidTaxRequest.md | 10 - 492 files changed, 9477 deletions(-) delete mode 100644 docs/PushFunds401Response.md delete mode 100644 docs/PushFunds404Response.md delete mode 100644 docs/PushFunds502Response.md delete mode 100644 docs/PushFundsApi.md delete mode 100644 docs/PushFundsRequest.md delete mode 100644 docs/Rbsv1plansClientReferenceInformation.md delete mode 100644 docs/Rbsv1plansOrderInformation.md delete mode 100644 docs/Rbsv1plansOrderInformationAmountDetails.md delete mode 100644 docs/Rbsv1plansPlanInformation.md delete mode 100644 docs/Rbsv1plansPlanInformationBillingCycles.md delete mode 100644 docs/Rbsv1plansidPlanInformation.md delete mode 100644 docs/Rbsv1plansidProcessingInformation.md delete mode 100644 docs/Rbsv1plansidProcessingInformationSubscriptionBillingOptions.md delete mode 100644 docs/Rbsv1subscriptionsClientReferenceInformation.md delete mode 100644 docs/Rbsv1subscriptionsClientReferenceInformationPartner.md delete mode 100644 docs/Rbsv1subscriptionsPaymentInformation.md delete mode 100644 docs/Rbsv1subscriptionsPaymentInformationCustomer.md delete mode 100644 docs/Rbsv1subscriptionsPlanInformation.md delete mode 100644 docs/Rbsv1subscriptionsProcessingInformation.md delete mode 100644 docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptions.md delete mode 100644 docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.md delete mode 100644 docs/Rbsv1subscriptionsSubscriptionInformation.md delete mode 100644 docs/Rbsv1subscriptionsidOrderInformation.md delete mode 100644 docs/Rbsv1subscriptionsidOrderInformationAmountDetails.md delete mode 100644 docs/Rbsv1subscriptionsidPlanInformation.md delete mode 100644 docs/Rbsv1subscriptionsidSubscriptionInformation.md delete mode 100644 docs/RefreshPaymentStatusRequest.md delete mode 100644 docs/RefundApi.md delete mode 100644 docs/RefundCaptureRequest.md delete mode 100644 docs/RefundPaymentRequest.md delete mode 100644 docs/ReportDefinitionsApi.md delete mode 100644 docs/ReportDownloadsApi.md delete mode 100644 docs/ReportSubscriptionsApi.md delete mode 100644 docs/ReportingV3ChargebackDetailsGet200Response.md delete mode 100644 docs/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md delete mode 100644 docs/ReportingV3ChargebackSummariesGet200Response.md delete mode 100644 docs/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md delete mode 100644 docs/ReportingV3ConversionDetailsGet200Response.md delete mode 100644 docs/ReportingV3ConversionDetailsGet200ResponseConversionDetails.md delete mode 100644 docs/ReportingV3ConversionDetailsGet200ResponseNotes.md delete mode 100644 docs/ReportingV3InterchangeClearingLevelDetailsGet200Response.md delete mode 100644 docs/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md delete mode 100644 docs/ReportingV3NetFundingsGet200Response.md delete mode 100644 docs/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md delete mode 100644 docs/ReportingV3NetFundingsGet200ResponseTotalPurchases.md delete mode 100644 docs/ReportingV3NotificationofChangesGet200Response.md delete mode 100644 docs/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md delete mode 100644 docs/ReportingV3PaymentBatchSummariesGet200Response.md delete mode 100644 docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md delete mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200Response.md delete mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md delete mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md delete mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md delete mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md delete mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md delete mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md delete mode 100644 docs/ReportingV3ReportDefinitionsGet200Response.md delete mode 100644 docs/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.md delete mode 100644 docs/ReportingV3ReportDefinitionsNameGet200Response.md delete mode 100644 docs/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md delete mode 100644 docs/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md delete mode 100644 docs/ReportingV3ReportSubscriptionsGet200Response.md delete mode 100644 docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md delete mode 100644 docs/ReportingV3ReportsGet200Response.md delete mode 100644 docs/ReportingV3ReportsGet200ResponseLink.md delete mode 100644 docs/ReportingV3ReportsGet200ResponseLinkReportDownload.md delete mode 100644 docs/ReportingV3ReportsGet200ResponseReportSearchResults.md delete mode 100644 docs/ReportingV3ReportsIdGet200Response.md delete mode 100644 docs/ReportingV3RetrievalDetailsGet200Response.md delete mode 100644 docs/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md delete mode 100644 docs/ReportingV3RetrievalSummariesGet200Response.md delete mode 100644 docs/Reportingv3ReportDownloadsGet400Response.md delete mode 100644 docs/Reportingv3ReportDownloadsGet400ResponseDetails.md delete mode 100644 docs/Reportingv3reportsReportFilters.md delete mode 100644 docs/Reportingv3reportsReportPreferences.md delete mode 100644 docs/ReportsApi.md delete mode 100644 docs/Request.md delete mode 100644 docs/ResourceNotFoundError.md delete mode 100644 docs/RetrievalDetailsApi.md delete mode 100644 docs/RetrievalSummariesApi.md delete mode 100644 docs/ReversalApi.md delete mode 100644 docs/RiskProducts.md delete mode 100644 docs/RiskProductsDecisionManager.md delete mode 100644 docs/RiskProductsDecisionManagerConfigurationInformation.md delete mode 100644 docs/RiskProductsFraudManagementEssentials.md delete mode 100644 docs/RiskProductsFraudManagementEssentialsConfigurationInformation.md delete mode 100644 docs/RiskProductsPortfolioRiskControls.md delete mode 100644 docs/RiskProductsPortfolioRiskControlsConfigurationInformation.md delete mode 100644 docs/RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.md delete mode 100644 docs/RiskV1AddressVerificationsPost201Response.md delete mode 100644 docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md delete mode 100644 docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md delete mode 100644 docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.md delete mode 100644 docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md delete mode 100644 docs/RiskV1AddressVerificationsPost201ResponseErrorInformation.md delete mode 100644 docs/RiskV1AuthenticationResultsPost201Response.md delete mode 100644 docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md delete mode 100644 docs/RiskV1AuthenticationSetupsPost201Response.md delete mode 100644 docs/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md delete mode 100644 docs/RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md delete mode 100644 docs/RiskV1AuthenticationsPost201Response.md delete mode 100644 docs/RiskV1AuthenticationsPost201ResponseErrorInformation.md delete mode 100644 docs/RiskV1AuthenticationsPost400Response.md delete mode 100644 docs/RiskV1AuthenticationsPost400Response1.md delete mode 100644 docs/RiskV1DecisionsPost201Response.md delete mode 100644 docs/RiskV1DecisionsPost201ResponseClientReferenceInformation.md delete mode 100644 docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md delete mode 100644 docs/RiskV1DecisionsPost201ResponseErrorInformation.md delete mode 100644 docs/RiskV1DecisionsPost201ResponseOrderInformation.md delete mode 100644 docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md delete mode 100644 docs/RiskV1DecisionsPost201ResponsePaymentInformation.md delete mode 100644 docs/RiskV1DecisionsPost400Response.md delete mode 100644 docs/RiskV1DecisionsPost400Response1.md delete mode 100644 docs/RiskV1ExportComplianceInquiriesPost201Response.md delete mode 100644 docs/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.md delete mode 100644 docs/RiskV1UpdatePost201Response.md delete mode 100644 docs/Riskv1addressverificationsBuyerInformation.md delete mode 100644 docs/Riskv1addressverificationsOrderInformation.md delete mode 100644 docs/Riskv1addressverificationsOrderInformationBillTo.md delete mode 100644 docs/Riskv1addressverificationsOrderInformationLineItems.md delete mode 100644 docs/Riskv1addressverificationsOrderInformationShipTo.md delete mode 100644 docs/Riskv1authenticationresultsConsumerAuthenticationInformation.md delete mode 100644 docs/Riskv1authenticationresultsDeviceInformation.md delete mode 100644 docs/Riskv1authenticationresultsOrderInformation.md delete mode 100644 docs/Riskv1authenticationresultsOrderInformationAmountDetails.md delete mode 100644 docs/Riskv1authenticationresultsPaymentInformation.md delete mode 100644 docs/Riskv1authenticationresultsPaymentInformationCard.md delete mode 100644 docs/Riskv1authenticationresultsPaymentInformationFluidData.md delete mode 100644 docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md delete mode 100644 docs/Riskv1authenticationsBuyerInformation.md delete mode 100644 docs/Riskv1authenticationsDeviceInformation.md delete mode 100644 docs/Riskv1authenticationsOrderInformation.md delete mode 100644 docs/Riskv1authenticationsOrderInformationAmountDetails.md delete mode 100644 docs/Riskv1authenticationsOrderInformationBillTo.md delete mode 100644 docs/Riskv1authenticationsOrderInformationLineItems.md delete mode 100644 docs/Riskv1authenticationsPaymentInformation.md delete mode 100644 docs/Riskv1authenticationsPaymentInformationCustomer.md delete mode 100644 docs/Riskv1authenticationsPaymentInformationTokenizedCard.md delete mode 100644 docs/Riskv1authenticationsRiskInformation.md delete mode 100644 docs/Riskv1authenticationsTravelInformation.md delete mode 100644 docs/Riskv1authenticationsetupsClientReferenceInformation.md delete mode 100644 docs/Riskv1authenticationsetupsPaymentInformation.md delete mode 100644 docs/Riskv1authenticationsetupsPaymentInformationCard.md delete mode 100644 docs/Riskv1authenticationsetupsPaymentInformationCustomer.md delete mode 100644 docs/Riskv1authenticationsetupsPaymentInformationFluidData.md delete mode 100644 docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md delete mode 100644 docs/Riskv1authenticationsetupsProcessingInformation.md delete mode 100644 docs/Riskv1authenticationsetupsTokenInformation.md delete mode 100644 docs/Riskv1decisionsAcquirerInformation.md delete mode 100644 docs/Riskv1decisionsBuyerInformation.md delete mode 100644 docs/Riskv1decisionsClientReferenceInformation.md delete mode 100644 docs/Riskv1decisionsClientReferenceInformationPartner.md delete mode 100644 docs/Riskv1decisionsConsumerAuthenticationInformation.md delete mode 100644 docs/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md delete mode 100644 docs/Riskv1decisionsDeviceInformation.md delete mode 100644 docs/Riskv1decisionsMerchantDefinedInformation.md delete mode 100644 docs/Riskv1decisionsMerchantInformation.md delete mode 100644 docs/Riskv1decisionsMerchantInformationMerchantDescriptor.md delete mode 100644 docs/Riskv1decisionsOrderInformation.md delete mode 100644 docs/Riskv1decisionsOrderInformationAmountDetails.md delete mode 100644 docs/Riskv1decisionsOrderInformationBillTo.md delete mode 100644 docs/Riskv1decisionsOrderInformationLineItems.md delete mode 100644 docs/Riskv1decisionsOrderInformationShipTo.md delete mode 100644 docs/Riskv1decisionsOrderInformationShippingDetails.md delete mode 100644 docs/Riskv1decisionsPaymentInformation.md delete mode 100644 docs/Riskv1decisionsPaymentInformationCard.md delete mode 100644 docs/Riskv1decisionsPaymentInformationTokenizedCard.md delete mode 100644 docs/Riskv1decisionsProcessingInformation.md delete mode 100644 docs/Riskv1decisionsProcessorInformation.md delete mode 100644 docs/Riskv1decisionsProcessorInformationAvs.md delete mode 100644 docs/Riskv1decisionsProcessorInformationCardVerification.md delete mode 100644 docs/Riskv1decisionsRiskInformation.md delete mode 100644 docs/Riskv1decisionsTokenInformation.md delete mode 100644 docs/Riskv1decisionsTravelInformation.md delete mode 100644 docs/Riskv1decisionsTravelInformationLegs.md delete mode 100644 docs/Riskv1decisionsTravelInformationPassengers.md delete mode 100644 docs/Riskv1decisionsidactionsDecisionInformation.md delete mode 100644 docs/Riskv1decisionsidactionsProcessingInformation.md delete mode 100644 docs/Riskv1decisionsidmarkingRiskInformation.md delete mode 100644 docs/Riskv1decisionsidmarkingRiskInformationMarkingDetails.md delete mode 100644 docs/Riskv1exportcomplianceinquiriesDeviceInformation.md delete mode 100644 docs/Riskv1exportcomplianceinquiriesExportComplianceInformation.md delete mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformation.md delete mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md delete mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md delete mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md delete mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformationShipTo.md delete mode 100644 docs/Riskv1liststypeentriesBuyerInformation.md delete mode 100644 docs/Riskv1liststypeentriesClientReferenceInformation.md delete mode 100644 docs/Riskv1liststypeentriesDeviceInformation.md delete mode 100644 docs/Riskv1liststypeentriesOrderInformation.md delete mode 100644 docs/Riskv1liststypeentriesOrderInformationAddress.md delete mode 100644 docs/Riskv1liststypeentriesOrderInformationBillTo.md delete mode 100644 docs/Riskv1liststypeentriesOrderInformationLineItems.md delete mode 100644 docs/Riskv1liststypeentriesOrderInformationShipTo.md delete mode 100644 docs/Riskv1liststypeentriesPaymentInformation.md delete mode 100644 docs/Riskv1liststypeentriesPaymentInformationBank.md delete mode 100644 docs/Riskv1liststypeentriesPaymentInformationCard.md delete mode 100644 docs/Riskv1liststypeentriesRiskInformation.md delete mode 100644 docs/Riskv1liststypeentriesRiskInformationMarkingDetails.md delete mode 100644 docs/SAConfig.md delete mode 100644 docs/SAConfigCheckout.md delete mode 100644 docs/SAConfigContactInformation.md delete mode 100644 docs/SAConfigNotifications.md delete mode 100644 docs/SAConfigNotificationsCustomerNotifications.md delete mode 100644 docs/SAConfigNotificationsMerchantNotifications.md delete mode 100644 docs/SAConfigPaymentMethods.md delete mode 100644 docs/SAConfigPaymentTypes.md delete mode 100644 docs/SAConfigPaymentTypesCardTypes.md delete mode 100644 docs/SAConfigPaymentTypesCardTypesDiscover.md delete mode 100644 docs/SAConfigService.md delete mode 100644 docs/SaveAsymEgressKey.md delete mode 100644 docs/SaveSymEgressKey.md delete mode 100644 docs/SearchRequest.md delete mode 100644 docs/SearchTransactionsApi.md delete mode 100644 docs/SecureFileShareApi.md delete mode 100644 docs/ShippingAddressListForCustomer.md delete mode 100644 docs/ShippingAddressListForCustomerEmbedded.md delete mode 100644 docs/ShippingAddressListForCustomerLinks.md delete mode 100644 docs/ShippingAddressListForCustomerLinksFirst.md delete mode 100644 docs/ShippingAddressListForCustomerLinksLast.md delete mode 100644 docs/ShippingAddressListForCustomerLinksNext.md delete mode 100644 docs/ShippingAddressListForCustomerLinksPrev.md delete mode 100644 docs/ShippingAddressListForCustomerLinksSelf.md delete mode 100644 docs/SubscriptionsApi.md delete mode 100644 docs/SubscriptionsFollowOnsApi.md delete mode 100644 docs/SuspendSubscriptionResponse.md delete mode 100644 docs/SuspendSubscriptionResponseSubscriptionInformation.md delete mode 100644 docs/TaxRequest.md delete mode 100644 docs/TaxesApi.md delete mode 100644 docs/TmsAuthorizationOptions.md delete mode 100644 docs/TmsAuthorizationOptionsInitiator.md delete mode 100644 docs/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md delete mode 100644 docs/TmsBinLookup.md delete mode 100644 docs/TmsBinLookupIssuerInformation.md delete mode 100644 docs/TmsBinLookupPaymentAccountInformation.md delete mode 100644 docs/TmsBinLookupPaymentAccountInformationCard.md delete mode 100644 docs/TmsBinLookupPaymentAccountInformationCardBrands.md delete mode 100644 docs/TmsBinLookupPaymentAccountInformationFeatures.md delete mode 100644 docs/TmsBinLookupPaymentAccountInformationNetwork.md delete mode 100644 docs/TmsBusinessInformation.md delete mode 100644 docs/TmsBusinessInformationAcquirer.md delete mode 100644 docs/TmsBusinessInformationAddress.md delete mode 100644 docs/TmsCardArt.md delete mode 100644 docs/TmsCardArtBrandLogoAsset.md delete mode 100644 docs/TmsCardArtBrandLogoAssetLinks.md delete mode 100644 docs/TmsCardArtBrandLogoAssetLinksSelf.md delete mode 100644 docs/TmsCardArtCombinedAsset.md delete mode 100644 docs/TmsCardArtCombinedAssetLinks.md delete mode 100644 docs/TmsCardArtCombinedAssetLinksSelf.md delete mode 100644 docs/TmsCardArtIconAsset.md delete mode 100644 docs/TmsCardArtIconAssetLinks.md delete mode 100644 docs/TmsCardArtIconAssetLinksSelf.md delete mode 100644 docs/TmsCardArtIssuerLogoAsset.md delete mode 100644 docs/TmsCardArtIssuerLogoAssetLinks.md delete mode 100644 docs/TmsCardArtIssuerLogoAssetLinksSelf.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifier.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierBankAccount.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierBillTo.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierCard.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierEmbedded.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierIssuer.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierLinks.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierLinksSelf.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierMetadata.md delete mode 100644 docs/TmsEmbeddedInstrumentIdentifierProcessingInformation.md delete mode 100644 docs/TmsNetworkTokenServices.md delete mode 100644 docs/TmsNetworkTokenServicesAmericanExpressTokenService.md delete mode 100644 docs/TmsNetworkTokenServicesMastercardDigitalEnablementService.md delete mode 100644 docs/TmsNetworkTokenServicesNotifications.md delete mode 100644 docs/TmsNetworkTokenServicesPaymentCredentials.md delete mode 100644 docs/TmsNetworkTokenServicesSynchronousProvisioning.md delete mode 100644 docs/TmsNetworkTokenServicesVisaTokenService.md delete mode 100644 docs/TmsNullify.md delete mode 100644 docs/TmsPaymentInstrumentProcessingInfo.md delete mode 100644 docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md delete mode 100644 docs/TmsSensitivePrivileges.md delete mode 100644 docs/TmsTokenFormats.md delete mode 100644 docs/Tmsv2TokenizedCard.md delete mode 100644 docs/Tmsv2TokenizedCardCard.md delete mode 100644 docs/Tmsv2TokenizedCardLinks.md delete mode 100644 docs/Tmsv2TokenizedCardLinksSelf.md delete mode 100644 docs/Tmsv2TokenizedCardMetadata.md delete mode 100644 docs/Tmsv2TokenizedCardMetadataIssuer.md delete mode 100644 docs/Tmsv2TokenizedCardPasscode.md delete mode 100644 docs/Tmsv2customersBuyerInformation.md delete mode 100644 docs/Tmsv2customersClientReferenceInformation.md delete mode 100644 docs/Tmsv2customersDefaultPaymentInstrument.md delete mode 100644 docs/Tmsv2customersDefaultShippingAddress.md delete mode 100644 docs/Tmsv2customersEmbedded.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrument.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddress.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md delete mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md delete mode 100644 docs/Tmsv2customersLinks.md delete mode 100644 docs/Tmsv2customersLinksPaymentInstruments.md delete mode 100644 docs/Tmsv2customersLinksSelf.md delete mode 100644 docs/Tmsv2customersLinksShippingAddress.md delete mode 100644 docs/Tmsv2customersMerchantDefinedInformation.md delete mode 100644 docs/Tmsv2customersMetadata.md delete mode 100644 docs/Tmsv2customersObjectInformation.md delete mode 100644 docs/TokenApi.md delete mode 100644 docs/TokenPermissions.md delete mode 100644 docs/TokenizedCardApi.md delete mode 100644 docs/TokenizedcardRequest.md delete mode 100644 docs/TransactionBatchesApi.md delete mode 100644 docs/TransactionDetailsApi.md delete mode 100644 docs/TransientTokenDataApi.md delete mode 100644 docs/TssV2GetEmvTags200Response.md delete mode 100644 docs/TssV2GetEmvTags200ResponseEmvTagBreakdownList.md delete mode 100644 docs/TssV2PostEmvTags200Response.md delete mode 100644 docs/TssV2PostEmvTags200ResponseEmvTagBreakdownList.md delete mode 100644 docs/TssV2PostEmvTags200ResponseParsedEMVTagsList.md delete mode 100644 docs/TssV2TransactionsGet200Response.md delete mode 100644 docs/TssV2TransactionsGet200ResponseApplicationInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseApplicationInformationApplications.md delete mode 100644 docs/TssV2TransactionsGet200ResponseBankAccountValidation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseBuyerInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md delete mode 100644 docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md delete mode 100644 docs/TssV2TransactionsGet200ResponseDeviceInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseErrorInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseFraudMarkingInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseInstallmentInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseLinks.md delete mode 100644 docs/TssV2TransactionsGet200ResponseMerchantInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.md delete mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md delete mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md delete mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.md delete mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md delete mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md delete mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationBrands.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationInvoice.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePayoutOptions.md delete mode 100644 docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessorInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md delete mode 100644 docs/TssV2TransactionsGet200ResponseProcessorInformationProcessor.md delete mode 100644 docs/TssV2TransactionsGet200ResponseRecurringPaymentInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseRiskInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md delete mode 100644 docs/TssV2TransactionsGet200ResponseRiskInformationRules.md delete mode 100644 docs/TssV2TransactionsGet200ResponseRiskInformationScore.md delete mode 100644 docs/TssV2TransactionsGet200ResponseSenderInformation.md delete mode 100644 docs/TssV2TransactionsGet200ResponseTokenInformation.md delete mode 100644 docs/TssV2TransactionsPost201Response.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbedded.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedLinks.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md delete mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md delete mode 100644 docs/Tssv2transactionsemvTagDetailsEmvDetailsList.md delete mode 100644 docs/UmsV1UsersGet200Response.md delete mode 100644 docs/UmsV1UsersGet200ResponseAccountInformation.md delete mode 100644 docs/UmsV1UsersGet200ResponseContactInformation.md delete mode 100644 docs/UmsV1UsersGet200ResponseOrganizationInformation.md delete mode 100644 docs/UmsV1UsersGet200ResponseUsers.md delete mode 100644 docs/UnauthorizedClientError.md delete mode 100644 docs/UnifiedCheckoutCaptureContextApi.md delete mode 100644 docs/UpdateInvoiceRequest.md delete mode 100644 docs/UpdateOrderRequest.md delete mode 100644 docs/UpdatePaymentLinkRequest.md delete mode 100644 docs/UpdatePlanRequest.md delete mode 100644 docs/UpdatePlanResponse.md delete mode 100644 docs/UpdatePlanResponsePlanInformation.md delete mode 100644 docs/UpdateStatus.md delete mode 100644 docs/UpdateSubscription.md delete mode 100644 docs/UpdateSubscriptionResponse.md delete mode 100644 docs/UpdateWebhook.md delete mode 100644 docs/Upv1capturecontextsCaptureMandate.md delete mode 100644 docs/Upv1capturecontextsCompleteMandate.md delete mode 100644 docs/Upv1capturecontextsOrderInformation.md delete mode 100644 docs/Upv1capturecontextsOrderInformationAmountDetails.md delete mode 100644 docs/Upv1capturecontextsOrderInformationBillTo.md delete mode 100644 docs/Upv1capturecontextsOrderInformationBillToCompany.md delete mode 100644 docs/Upv1capturecontextsOrderInformationShipTo.md delete mode 100644 docs/UserManagementApi.md delete mode 100644 docs/UserManagementSearchApi.md delete mode 100644 docs/V1FileDetailsGet200Response.md delete mode 100644 docs/V1FileDetailsGet200ResponseFileDetails.md delete mode 100644 docs/V1FileDetailsGet200ResponseLinks.md delete mode 100644 docs/V1FileDetailsGet200ResponseLinksFiles.md delete mode 100644 docs/V1FileDetailsGet200ResponseLinksSelf.md delete mode 100644 docs/VTConfig.md delete mode 100644 docs/VTConfigCardNotPresent.md delete mode 100644 docs/VTConfigCardNotPresentGlobalPaymentInformation.md delete mode 100644 docs/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md delete mode 100644 docs/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.md delete mode 100644 docs/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md delete mode 100644 docs/VTConfigCardNotPresentReceiptInformation.md delete mode 100644 docs/VTConfigCardNotPresentReceiptInformationEmailReceipt.md delete mode 100644 docs/VTConfigCardNotPresentReceiptInformationHeader.md delete mode 100644 docs/VTConfigCardNotPresentReceiptInformationOrderInformation.md delete mode 100644 docs/ValidateExportComplianceRequest.md delete mode 100644 docs/ValidateRequest.md delete mode 100644 docs/ValueAddedServicesProducts.md delete mode 100644 docs/VasV2PaymentsPost201Response.md delete mode 100644 docs/VasV2PaymentsPost201ResponseLinks.md delete mode 100644 docs/VasV2PaymentsPost201ResponseOrderInformation.md delete mode 100644 docs/VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md delete mode 100644 docs/VasV2PaymentsPost201ResponseOrderInformationLineItems.md delete mode 100644 docs/VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md delete mode 100644 docs/VasV2PaymentsPost201ResponseTaxInformation.md delete mode 100644 docs/VasV2PaymentsPost400Response.md delete mode 100644 docs/VasV2TaxVoid200Response.md delete mode 100644 docs/VasV2TaxVoid200ResponseVoidAmountDetails.md delete mode 100644 docs/VasV2TaxVoidsPost400Response.md delete mode 100644 docs/Vasv2taxBuyerInformation.md delete mode 100644 docs/Vasv2taxClientReferenceInformation.md delete mode 100644 docs/Vasv2taxMerchantInformation.md delete mode 100644 docs/Vasv2taxOrderInformation.md delete mode 100644 docs/Vasv2taxOrderInformationBillTo.md delete mode 100644 docs/Vasv2taxOrderInformationInvoiceDetails.md delete mode 100644 docs/Vasv2taxOrderInformationLineItems.md delete mode 100644 docs/Vasv2taxOrderInformationOrderAcceptance.md delete mode 100644 docs/Vasv2taxOrderInformationOrderOrigin.md delete mode 100644 docs/Vasv2taxOrderInformationShipTo.md delete mode 100644 docs/Vasv2taxOrderInformationShippingDetails.md delete mode 100644 docs/Vasv2taxTaxInformation.md delete mode 100644 docs/Vasv2taxidClientReferenceInformation.md delete mode 100644 docs/Vasv2taxidClientReferenceInformationPartner.md delete mode 100644 docs/VerificationApi.md delete mode 100644 docs/VerifyCustomerAddressRequest.md delete mode 100644 docs/VoidApi.md delete mode 100644 docs/VoidCaptureRequest.md delete mode 100644 docs/VoidCreditRequest.md delete mode 100644 docs/VoidPaymentRequest.md delete mode 100644 docs/VoidRefundRequest.md delete mode 100644 docs/VoidTaxRequest.md diff --git a/docs/PushFunds401Response.md b/docs/PushFunds401Response.md deleted file mode 100644 index 48f43d9b..00000000 --- a/docs/PushFunds401Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# PushFunds401Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | A unique identification number to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] -**submit_time_utc** | **str** | 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] -**reason** | **str** | The reason of the status. Possible values: - UNAUTHORIZED | [optional] -**message** | **str** | The detail message related to the status and reason listed above. Possible values: - Authentication Failed | [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/PushFunds404Response.md b/docs/PushFunds404Response.md deleted file mode 100644 index f07d5d85..00000000 --- a/docs/PushFunds404Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# PushFunds404Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | A unique identification number to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] -**submit_time_utc** | **str** | 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] -**reason** | **str** | The reason of the status. Possible values: - NOT_FOUND | [optional] -**message** | **str** | The detail message related to the status and reason listed above. Possible values: - The requested resource does not exist | [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/PushFunds502Response.md b/docs/PushFunds502Response.md deleted file mode 100644 index c6ab5430..00000000 --- a/docs/PushFunds502Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# PushFunds502Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | A unique identification number to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] -**submit_time_utc** | **str** | 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** | **str** | Possible values: - SERVER_ERROR | [optional] -**reason** | **str** | The reason of the status. Possible values: - SYSTEM_ERROR - SERVICE_TIMEOUT | [optional] -**message** | **str** | The detail message related to the status and reason listed above. Possible values: - Error - General system failure. - The request was received, but a service did not finish running in time. | [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/PushFundsApi.md b/docs/PushFundsApi.md deleted file mode 100644 index ebf4f3d2..00000000 --- a/docs/PushFundsApi.md +++ /dev/null @@ -1,69 +0,0 @@ -# CyberSource.PushFundsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_push_funds_transfer**](PushFundsApi.md#create_push_funds_transfer) | **POST** /pts/v1/push-funds-transfer | Process a Push Funds Transfer - - -# **create_push_funds_transfer** -> PushFunds201Response create_push_funds_transfer(push_funds_request, content_type, x_requestid, v_c_merchant_id, v_c_permissions, v_c_correlation_id, v_c_organization_id) - -Process a Push Funds Transfer - -Receive funds using an Original Credit Transaction (OCT). - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.PushFundsApi() -push_funds_request = CyberSource.PushFundsRequest() # PushFundsRequest | -content_type = 'content_type_example' # str | -x_requestid = 'x_requestid_example' # str | -v_c_merchant_id = 'v_c_merchant_id_example' # str | -v_c_permissions = 'v_c_permissions_example' # str | -v_c_correlation_id = 'v_c_correlation_id_example' # str | -v_c_organization_id = 'v_c_organization_id_example' # str | - -try: - # Process a Push Funds Transfer - api_response = api_instance.create_push_funds_transfer(push_funds_request, content_type, x_requestid, v_c_merchant_id, v_c_permissions, v_c_correlation_id, v_c_organization_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling PushFundsApi->create_push_funds_transfer: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **push_funds_request** | [**PushFundsRequest**](PushFundsRequest.md)| | - **content_type** | **str**| | - **x_requestid** | **str**| | - **v_c_merchant_id** | **str**| | - **v_c_permissions** | **str**| | - **v_c_correlation_id** | **str**| | - **v_c_organization_id** | **str**| | - -### Return type - -[**PushFunds201Response**](PushFunds201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PushFundsRequest.md b/docs/PushFundsRequest.md deleted file mode 100644 index da473119..00000000 --- a/docs/PushFundsRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# PushFundsRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aggregator_information** | [**Ptsv2payoutsAggregatorInformation**](Ptsv2payoutsAggregatorInformation.md) | | [optional] -**client_reference_information** | [**Ptsv1pushfundstransferClientReferenceInformation**](Ptsv1pushfundstransferClientReferenceInformation.md) | | [optional] -**order_information** | [**Ptsv1pushfundstransferOrderInformation**](Ptsv1pushfundstransferOrderInformation.md) | | -**processing_information** | [**Ptsv1pushfundstransferProcessingInformation**](Ptsv1pushfundstransferProcessingInformation.md) | | [optional] -**recipient_information** | [**Ptsv1pushfundstransferRecipientInformation**](Ptsv1pushfundstransferRecipientInformation.md) | | [optional] -**sender_information** | [**Ptsv1pushfundstransferSenderInformation**](Ptsv1pushfundstransferSenderInformation.md) | | [optional] -**merchant_information** | [**Ptsv1pushfundstransferMerchantInformation**](Ptsv1pushfundstransferMerchantInformation.md) | | [optional] -**point_of_service_information** | [**Ptsv1pushfundstransferPointOfServiceInformation**](Ptsv1pushfundstransferPointOfServiceInformation.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/Rbsv1plansClientReferenceInformation.md b/docs/Rbsv1plansClientReferenceInformation.md deleted file mode 100644 index 0efc8bda..00000000 --- a/docs/Rbsv1plansClientReferenceInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# Rbsv1plansClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comments** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] -**application_name** | **str** | 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] -**application_version** | **str** | Version of the CyberSource application or integration used for a transaction. | [optional] -**application_user** | **str** | 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. | [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/Rbsv1plansOrderInformation.md b/docs/Rbsv1plansOrderInformation.md deleted file mode 100644 index fbb40798..00000000 --- a/docs/Rbsv1plansOrderInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1plansOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_details** | [**Rbsv1plansOrderInformationAmountDetails**](Rbsv1plansOrderInformationAmountDetails.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/Rbsv1plansOrderInformationAmountDetails.md b/docs/Rbsv1plansOrderInformationAmountDetails.md deleted file mode 100644 index fc163ba2..00000000 --- a/docs/Rbsv1plansOrderInformationAmountDetails.md +++ /dev/null @@ -1,12 +0,0 @@ -# Rbsv1plansOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **str** | 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. | -**billing_amount** | **str** | Billing amount for the billing period. | -**setup_fee** | **str** | Subscription setup fee | [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/Rbsv1plansPlanInformation.md b/docs/Rbsv1plansPlanInformation.md deleted file mode 100644 index 10a55ede..00000000 --- a/docs/Rbsv1plansPlanInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# Rbsv1plansPlanInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Plan code is an optional field, If not provided system generates and assign one | [optional] -**name** | **str** | Plan name | -**description** | **str** | Plan description | [optional] -**status** | **str** | Plan Status: - `DRAFT` - `ACTIVE` (default) | [optional] -**billing_period** | [**GetAllPlansResponsePlanInformationBillingPeriod**](GetAllPlansResponsePlanInformationBillingPeriod.md) | | -**billing_cycles** | [**Rbsv1plansPlanInformationBillingCycles**](Rbsv1plansPlanInformationBillingCycles.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/Rbsv1plansPlanInformationBillingCycles.md b/docs/Rbsv1plansPlanInformationBillingCycles.md deleted file mode 100644 index abd9857b..00000000 --- a/docs/Rbsv1plansPlanInformationBillingCycles.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1plansPlanInformationBillingCycles - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total** | **str** | Describe total number of billing cycles | [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/Rbsv1plansidPlanInformation.md b/docs/Rbsv1plansidPlanInformation.md deleted file mode 100644 index 3b2330f7..00000000 --- a/docs/Rbsv1plansidPlanInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# Rbsv1plansidPlanInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Plan code is an optional field, If not provided system generates and assign one | [optional] -**name** | **str** | Plan name | [optional] -**description** | **str** | Plan description | [optional] -**status** | **str** | Updating to `DRAFT` is not allowed from `ACTIVE` and `INACTIVE` status. Plan Status: - `DRAFT` - `ACTIVE` - `INACTIVE` | [optional] -**billing_period** | [**GetAllPlansResponsePlanInformationBillingPeriod**](GetAllPlansResponsePlanInformationBillingPeriod.md) | | [optional] -**billing_cycles** | [**Rbsv1plansPlanInformationBillingCycles**](Rbsv1plansPlanInformationBillingCycles.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/Rbsv1plansidProcessingInformation.md b/docs/Rbsv1plansidProcessingInformation.md deleted file mode 100644 index b14de9f8..00000000 --- a/docs/Rbsv1plansidProcessingInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1plansidProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**subscription_billing_options** | [**Rbsv1plansidProcessingInformationSubscriptionBillingOptions**](Rbsv1plansidProcessingInformationSubscriptionBillingOptions.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/Rbsv1plansidProcessingInformationSubscriptionBillingOptions.md b/docs/Rbsv1plansidProcessingInformationSubscriptionBillingOptions.md deleted file mode 100644 index a01e44e1..00000000 --- a/docs/Rbsv1plansidProcessingInformationSubscriptionBillingOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1plansidProcessingInformationSubscriptionBillingOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**apply_to** | **str** | Valid Values: - `ALL` - Change applied to all Subscriptions (Existing + New) - `NEW` - Change applied to New Subsciptions 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/Rbsv1subscriptionsClientReferenceInformation.md b/docs/Rbsv1subscriptionsClientReferenceInformation.md deleted file mode 100644 index d2f0b546..00000000 --- a/docs/Rbsv1subscriptionsClientReferenceInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# Rbsv1subscriptionsClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | > Deprecated: This field is ignored. 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** | **str** | > Deprecated: This field is ignored. Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**Rbsv1subscriptionsClientReferenceInformationPartner**](Rbsv1subscriptionsClientReferenceInformationPartner.md) | | [optional] -**application_name** | **str** | > Deprecated: This field is ignored. 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] -**application_version** | **str** | > Deprecated: This field is ignored. Version of the CyberSource application or integration used for a transaction. | [optional] -**application_user** | **str** | > Deprecated: This field is ignored. 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. | [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/Rbsv1subscriptionsClientReferenceInformationPartner.md b/docs/Rbsv1subscriptionsClientReferenceInformationPartner.md deleted file mode 100644 index 5c8f2060..00000000 --- a/docs/Rbsv1subscriptionsClientReferenceInformationPartner.md +++ /dev/null @@ -1,11 +0,0 @@ -# Rbsv1subscriptionsClientReferenceInformationPartner - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**developer_id** | **str** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. | [optional] -**solution_id** | **str** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [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/Rbsv1subscriptionsPaymentInformation.md b/docs/Rbsv1subscriptionsPaymentInformation.md deleted file mode 100644 index f0f59598..00000000 --- a/docs/Rbsv1subscriptionsPaymentInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1subscriptionsPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer** | [**Rbsv1subscriptionsPaymentInformationCustomer**](Rbsv1subscriptionsPaymentInformationCustomer.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/Rbsv1subscriptionsPaymentInformationCustomer.md b/docs/Rbsv1subscriptionsPaymentInformationCustomer.md deleted file mode 100644 index b9e63d50..00000000 --- a/docs/Rbsv1subscriptionsPaymentInformationCustomer.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1subscriptionsPaymentInformationCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | 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. | - -[[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/Rbsv1subscriptionsPlanInformation.md b/docs/Rbsv1subscriptionsPlanInformation.md deleted file mode 100644 index 3d040550..00000000 --- a/docs/Rbsv1subscriptionsPlanInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Rbsv1subscriptionsPlanInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**billing_period** | [**GetAllPlansResponsePlanInformationBillingPeriod**](GetAllPlansResponsePlanInformationBillingPeriod.md) | | [optional] -**billing_cycles** | [**Rbsv1plansPlanInformationBillingCycles**](Rbsv1plansPlanInformationBillingCycles.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/Rbsv1subscriptionsProcessingInformation.md b/docs/Rbsv1subscriptionsProcessingInformation.md deleted file mode 100644 index 1918e7b8..00000000 --- a/docs/Rbsv1subscriptionsProcessingInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Rbsv1subscriptionsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**commerce_indicator** | **str** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Commerce Indicator is a way to identify the type of transaction. Some payment card companies use this information when determining discount rates. Valid values: - `MOTO` - `RECURRING` - `INTERNET` Please add the ecommerce indicator based on the rules defined by your gateway/processor. Some gateways may not accept the Commerce Indicator `RECURRING` with a Zero Dollar Authorization, that is done for subscriptions starting at a future date. | [optional] -**authorization_options** | [**Rbsv1subscriptionsProcessingInformationAuthorizationOptions**](Rbsv1subscriptionsProcessingInformationAuthorizationOptions.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/Rbsv1subscriptionsProcessingInformationAuthorizationOptions.md b/docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptions.md deleted file mode 100644 index eae8e2e8..00000000 --- a/docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1subscriptionsProcessingInformationAuthorizationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**initiator** | [**Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator**](Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.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/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.md b/docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.md deleted file mode 100644 index 83598bf2..00000000 --- a/docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** | [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/Rbsv1subscriptionsSubscriptionInformation.md b/docs/Rbsv1subscriptionsSubscriptionInformation.md deleted file mode 100644 index 80abfa9d..00000000 --- a/docs/Rbsv1subscriptionsSubscriptionInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# Rbsv1subscriptionsSubscriptionInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Subscription code is an optional field, If not provided system generates and assign one | [optional] -**plan_id** | **str** | Plan Id. Use Plan Id from Create Plan Service. | [optional] -**name** | **str** | Subscription Name | -**start_date** | **str** | Start date of the Subscription Start date must be in UTC. Format: YYYY-MM-DDThh:mm:ssZ The T separates the date and the time. The Z indicates UTC. Note: Subscription starts on the day provided in UTC. **Example** 2022-08-11T22:47:57Z equals August 11, 2022, at 22:47:57 (10:47:57 p.m.). Subscription will start on August 11,2022. | -**original_transaction_id** | **str** | Network transaction identifier that was returned in the payment response field _processorInformation.transactionId_ in the reply message for the original subscription-initializing payment. | [optional] -**original_transaction_authorized_amount** | **str** | Amount of the original subscription-initializing payment. *Required when using a Diners or Discover card*. | [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/Rbsv1subscriptionsidOrderInformation.md b/docs/Rbsv1subscriptionsidOrderInformation.md deleted file mode 100644 index 6ae69549..00000000 --- a/docs/Rbsv1subscriptionsidOrderInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1subscriptionsidOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_details** | [**Rbsv1subscriptionsidOrderInformationAmountDetails**](Rbsv1subscriptionsidOrderInformationAmountDetails.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/Rbsv1subscriptionsidOrderInformationAmountDetails.md b/docs/Rbsv1subscriptionsidOrderInformationAmountDetails.md deleted file mode 100644 index 6c48c11d..00000000 --- a/docs/Rbsv1subscriptionsidOrderInformationAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# Rbsv1subscriptionsidOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**billing_amount** | **str** | Billing amount for the billing period. | [optional] -**setup_fee** | **str** | Subscription setup fee | [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/Rbsv1subscriptionsidPlanInformation.md b/docs/Rbsv1subscriptionsidPlanInformation.md deleted file mode 100644 index 2aa686ac..00000000 --- a/docs/Rbsv1subscriptionsidPlanInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Rbsv1subscriptionsidPlanInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**billing_cycles** | [**Rbsv1plansPlanInformationBillingCycles**](Rbsv1plansPlanInformationBillingCycles.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/Rbsv1subscriptionsidSubscriptionInformation.md b/docs/Rbsv1subscriptionsidSubscriptionInformation.md deleted file mode 100644 index ec4e878a..00000000 --- a/docs/Rbsv1subscriptionsidSubscriptionInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Rbsv1subscriptionsidSubscriptionInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Subscription code is an optional field, If not provided system generates and assign one | [optional] -**plan_id** | **str** | Plan Id. Use Plan Id from Create Plan Service. | [optional] -**name** | **str** | Subscription Name | [optional] -**start_date** | **str** | Start date of the Subscription Start date must be in UTC. Format: YYYY-MM-DDThh:mm:ssZ The T separates the date and the time. The Z indicates UTC. Note: Subscription starts on the day provided in UTC. **Example** 2022-08-11T22:47:57Z equals August 11, 2022, at 22:47:57 (10:47:57 p.m.). Subscription will start on August 11,2022. | [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/RefreshPaymentStatusRequest.md b/docs/RefreshPaymentStatusRequest.md deleted file mode 100644 index 069b839a..00000000 --- a/docs/RefreshPaymentStatusRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RefreshPaymentStatusRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_information** | [**Ptsv2refreshpaymentstatusidPaymentInformation**](Ptsv2refreshpaymentstatusidPaymentInformation.md) | | [optional] -**client_reference_information** | [**Ptsv2refreshpaymentstatusidClientReferenceInformation**](Ptsv2refreshpaymentstatusidClientReferenceInformation.md) | | [optional] -**agreement_information** | [**Ptsv2refreshpaymentstatusidAgreementInformation**](Ptsv2refreshpaymentstatusidAgreementInformation.md) | | [optional] -**processing_information** | [**Ptsv2refreshpaymentstatusidProcessingInformation**](Ptsv2refreshpaymentstatusidProcessingInformation.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/RefundApi.md b/docs/RefundApi.md deleted file mode 100644 index e0305b29..00000000 --- a/docs/RefundApi.md +++ /dev/null @@ -1,110 +0,0 @@ -# CyberSource.RefundApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**refund_capture**](RefundApi.md#refund_capture) | **POST** /pts/v2/captures/{id}/refunds | Refund a Capture -[**refund_payment**](RefundApi.md#refund_payment) | **POST** /pts/v2/payments/{id}/refunds | Refund a Payment - - -# **refund_capture** -> PtsV2PaymentsRefundPost201Response refund_capture(refund_capture_request, id) - -Refund a Capture - -Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. Include the capture ID in the POST request to refund the captured amount. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.RefundApi() -refund_capture_request = CyberSource.RefundCaptureRequest() # RefundCaptureRequest | -id = 'id_example' # str | The capture ID. This ID is returned from a previous capture request. - -try: - # Refund a Capture - api_response = api_instance.refund_capture(refund_capture_request, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling RefundApi->refund_capture: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **refund_capture_request** | [**RefundCaptureRequest**](RefundCaptureRequest.md)| | - **id** | **str**| The capture ID. This ID is returned from a previous capture request. | - -### Return type - -[**PtsV2PaymentsRefundPost201Response**](PtsV2PaymentsRefundPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **refund_payment** -> PtsV2PaymentsRefundPost201Response refund_payment(refund_payment_request, id) - -Refund a Payment - -Refund a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to refund the payment amount. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.RefundApi() -refund_payment_request = CyberSource.RefundPaymentRequest() # RefundPaymentRequest | -id = 'id_example' # str | The payment ID. This ID is returned from a previous payment request. - -try: - # Refund a Payment - api_response = api_instance.refund_payment(refund_payment_request, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling RefundApi->refund_payment: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **refund_payment_request** | [**RefundPaymentRequest**](RefundPaymentRequest.md)| | - **id** | **str**| The payment ID. This ID is returned from a previous payment request. | - -### Return type - -[**PtsV2PaymentsRefundPost201Response**](PtsV2PaymentsRefundPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/RefundCaptureRequest.md b/docs/RefundCaptureRequest.md deleted file mode 100644 index 9fc5bc85..00000000 --- a/docs/RefundCaptureRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# RefundCaptureRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Ptsv2paymentsidrefundsClientReferenceInformation**](Ptsv2paymentsidrefundsClientReferenceInformation.md) | | [optional] -**processing_information** | [**Ptsv2paymentsidrefundsProcessingInformation**](Ptsv2paymentsidrefundsProcessingInformation.md) | | [optional] -**payment_information** | [**Ptsv2paymentsidrefundsPaymentInformation**](Ptsv2paymentsidrefundsPaymentInformation.md) | | [optional] -**order_information** | [**Ptsv2paymentsidrefundsOrderInformation**](Ptsv2paymentsidrefundsOrderInformation.md) | | [optional] -**buyer_information** | [**Ptsv2paymentsidcapturesBuyerInformation**](Ptsv2paymentsidcapturesBuyerInformation.md) | | [optional] -**device_information** | [**Ptsv2paymentsidcapturesDeviceInformation**](Ptsv2paymentsidcapturesDeviceInformation.md) | | [optional] -**merchant_information** | [**Ptsv2paymentsidrefundsMerchantInformation**](Ptsv2paymentsidrefundsMerchantInformation.md) | | [optional] -**aggregator_information** | [**Ptsv2paymentsidcapturesAggregatorInformation**](Ptsv2paymentsidcapturesAggregatorInformation.md) | | [optional] -**point_of_sale_information** | [**Ptsv2paymentsidrefundsPointOfSaleInformation**](Ptsv2paymentsidrefundsPointOfSaleInformation.md) | | [optional] -**merchant_defined_information** | [**list[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] -**travel_information** | [**Ptsv2paymentsTravelInformation**](Ptsv2paymentsTravelInformation.md) | | [optional] -**promotion_information** | [**Ptsv2paymentsPromotionInformation**](Ptsv2paymentsPromotionInformation.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/RefundPaymentRequest.md b/docs/RefundPaymentRequest.md deleted file mode 100644 index 689efdc3..00000000 --- a/docs/RefundPaymentRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# RefundPaymentRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Ptsv2paymentsidrefundsClientReferenceInformation**](Ptsv2paymentsidrefundsClientReferenceInformation.md) | | [optional] -**processing_information** | [**Ptsv2paymentsidrefundsProcessingInformation**](Ptsv2paymentsidrefundsProcessingInformation.md) | | [optional] -**payment_information** | [**Ptsv2paymentsidrefundsPaymentInformation**](Ptsv2paymentsidrefundsPaymentInformation.md) | | [optional] -**order_information** | [**Ptsv2paymentsidrefundsOrderInformation**](Ptsv2paymentsidrefundsOrderInformation.md) | | [optional] -**buyer_information** | [**Ptsv2paymentsidcapturesBuyerInformation**](Ptsv2paymentsidcapturesBuyerInformation.md) | | [optional] -**device_information** | [**Ptsv2paymentsidcapturesDeviceInformation**](Ptsv2paymentsidcapturesDeviceInformation.md) | | [optional] -**merchant_information** | [**Ptsv2paymentsidrefundsMerchantInformation**](Ptsv2paymentsidrefundsMerchantInformation.md) | | [optional] -**aggregator_information** | [**Ptsv2paymentsidcapturesAggregatorInformation**](Ptsv2paymentsidcapturesAggregatorInformation.md) | | [optional] -**point_of_sale_information** | [**Ptsv2paymentsidrefundsPointOfSaleInformation**](Ptsv2paymentsidrefundsPointOfSaleInformation.md) | | [optional] -**merchant_defined_information** | [**list[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] -**travel_information** | [**Ptsv2paymentsTravelInformation**](Ptsv2paymentsTravelInformation.md) | | [optional] -**promotion_information** | [**Ptsv2paymentsPromotionInformation**](Ptsv2paymentsPromotionInformation.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/ReportDefinitionsApi.md b/docs/ReportDefinitionsApi.md deleted file mode 100644 index 26f342b6..00000000 --- a/docs/ReportDefinitionsApi.md +++ /dev/null @@ -1,114 +0,0 @@ -# CyberSource.ReportDefinitionsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_resource_info_by_report_definition**](ReportDefinitionsApi.md#get_resource_info_by_report_definition) | **GET** /reporting/v3/report-definitions/{reportDefinitionName} | Get Report Definition -[**get_resource_v2_info**](ReportDefinitionsApi.md#get_resource_v2_info) | **GET** /reporting/v3/report-definitions | Get Reporting Resource Information - - -# **get_resource_info_by_report_definition** -> ReportingV3ReportDefinitionsNameGet200Response get_resource_info_by_report_definition(report_definition_name, subscription_type=subscription_type, report_mime_type=report_mime_type, organization_id=organization_id) - -Get Report Definition - -View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/) - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportDefinitionsApi() -report_definition_name = 'report_definition_name_example' # str | Name of the Report definition to retrieve -subscription_type = 'subscription_type_example' # str | The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD (optional) -report_mime_type = 'report_mime_type_example' # str | The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv (optional) -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Get Report Definition - api_response = api_instance.get_resource_info_by_report_definition(report_definition_name, subscription_type=subscription_type, report_mime_type=report_mime_type, organization_id=organization_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ReportDefinitionsApi->get_resource_info_by_report_definition: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_definition_name** | **str**| Name of the Report definition to retrieve | - **subscription_type** | **str**| The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD | [optional] - **report_mime_type** | **str**| The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv | [optional] - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -[**ReportingV3ReportDefinitionsNameGet200Response**](ReportingV3ReportDefinitionsNameGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_resource_v2_info** -> ReportingV3ReportDefinitionsGet200Response get_resource_v2_info(subscription_type=subscription_type, organization_id=organization_id) - -Get Reporting Resource Information - -View a list of supported reports and their attributes before subscribing to them. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportDefinitionsApi() -subscription_type = 'subscription_type_example' # str | Valid Values: - CLASSIC - CUSTOM - STANDARD (optional) -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Get Reporting Resource Information - api_response = api_instance.get_resource_v2_info(subscription_type=subscription_type, organization_id=organization_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ReportDefinitionsApi->get_resource_v2_info: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_type** | **str**| Valid Values: - CLASSIC - CUSTOM - STANDARD | [optional] - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -[**ReportingV3ReportDefinitionsGet200Response**](ReportingV3ReportDefinitionsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/ReportDownloadsApi.md b/docs/ReportDownloadsApi.md deleted file mode 100644 index d3ad4675..00000000 --- a/docs/ReportDownloadsApi.md +++ /dev/null @@ -1,60 +0,0 @@ -# CyberSource.ReportDownloadsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**download_report**](ReportDownloadsApi.md#download_report) | **GET** /reporting/v3/report-downloads | Download a Report - - -# **download_report** -> download_report(report_date, report_name, organization_id=organization_id) - -Download a Report - -Download a report using the unique report name and date. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportDownloadsApi() -report_date = '2013-10-20' # date | Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 -report_name = 'report_name_example' # str | Name of the report to download -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Download a Report - api_instance.download_report(report_date, report_name, organization_id=organization_id) -except ApiException as e: - print("Exception when calling ReportDownloadsApi->download_report: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_date** | **date**| Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 | - **report_name** | **str**| Name of the report to download | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/xml, text/csv - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/ReportSubscriptionsApi.md b/docs/ReportSubscriptionsApi.md deleted file mode 100644 index 907b7dc1..00000000 --- a/docs/ReportSubscriptionsApi.md +++ /dev/null @@ -1,258 +0,0 @@ -# CyberSource.ReportSubscriptionsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_standard_or_classic_subscription**](ReportSubscriptionsApi.md#create_standard_or_classic_subscription) | **PUT** /reporting/v3/predefined-report-subscriptions | Create a Standard or Classic Subscription -[**create_subscription**](ReportSubscriptionsApi.md#create_subscription) | **PUT** /reporting/v3/report-subscriptions | Create Report Subscription for a Report Name by Organization -[**delete_subscription**](ReportSubscriptionsApi.md#delete_subscription) | **DELETE** /reporting/v3/report-subscriptions/{reportName} | Delete Subscription of a Report Name by Organization -[**get_all_subscriptions**](ReportSubscriptionsApi.md#get_all_subscriptions) | **GET** /reporting/v3/report-subscriptions | Get All Subscriptions -[**get_subscription**](ReportSubscriptionsApi.md#get_subscription) | **GET** /reporting/v3/report-subscriptions/{reportName} | Get Subscription for Report Name - - -# **create_standard_or_classic_subscription** -> create_standard_or_classic_subscription(predefined_subscription_request_bean, organization_id=organization_id) - -Create a Standard or Classic Subscription - -Create or update an already existing classic or standard subscription. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportSubscriptionsApi() -predefined_subscription_request_bean = CyberSource.PredefinedSubscriptionRequestBean() # PredefinedSubscriptionRequestBean | Report subscription request payload -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Create a Standard or Classic Subscription - api_instance.create_standard_or_classic_subscription(predefined_subscription_request_bean, organization_id=organization_id) -except ApiException as e: - print("Exception when calling ReportSubscriptionsApi->create_standard_or_classic_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **predefined_subscription_request_bean** | [**PredefinedSubscriptionRequestBean**](PredefinedSubscriptionRequestBean.md)| Report subscription request payload | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_subscription** -> create_subscription(create_report_subscription_request, organization_id=organization_id) - -Create Report Subscription for a Report Name by Organization - -Create a report subscription for your organization. The report name must be unique. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportSubscriptionsApi() -create_report_subscription_request = CyberSource.CreateReportSubscriptionRequest() # CreateReportSubscriptionRequest | Report subscription request payload -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Create Report Subscription for a Report Name by Organization - api_instance.create_subscription(create_report_subscription_request, organization_id=organization_id) -except ApiException as e: - print("Exception when calling ReportSubscriptionsApi->create_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **create_report_subscription_request** | [**CreateReportSubscriptionRequest**](CreateReportSubscriptionRequest.md)| Report subscription request payload | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_subscription** -> delete_subscription(report_name, organization_id=organization_id) - -Delete Subscription of a Report Name by Organization - -Delete a report subscription for your organization. You must know the unique name of the report you want to delete. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportSubscriptionsApi() -report_name = 'report_name_example' # str | Name of the Report to Delete -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Delete Subscription of a Report Name by Organization - api_instance.delete_subscription(report_name, organization_id=organization_id) -except ApiException as e: - print("Exception when calling ReportSubscriptionsApi->delete_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_name** | **str**| Name of the Report to Delete | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_subscriptions** -> ReportingV3ReportSubscriptionsGet200Response get_all_subscriptions(organization_id=organization_id) - -Get All Subscriptions - -View a summary of all report subscriptions. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportSubscriptionsApi() -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Get All Subscriptions - api_response = api_instance.get_all_subscriptions(organization_id=organization_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ReportSubscriptionsApi->get_all_subscriptions: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -[**ReportingV3ReportSubscriptionsGet200Response**](ReportingV3ReportSubscriptionsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_subscription** -> ReportingV3ReportSubscriptionsGet200ResponseSubscriptions get_subscription(report_name, organization_id=organization_id) - -Get Subscription for Report Name - -View the details of a report subscription, such as the report format or report frequency, using the report's unique name. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportSubscriptionsApi() -report_name = 'report_name_example' # str | Name of the Report to Retrieve -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Get Subscription for Report Name - api_response = api_instance.get_subscription(report_name, organization_id=organization_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ReportSubscriptionsApi->get_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_name** | **str**| Name of the Report to Retrieve | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -[**ReportingV3ReportSubscriptionsGet200ResponseSubscriptions**](ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/ReportingV3ChargebackDetailsGet200Response.md b/docs/ReportingV3ChargebackDetailsGet200Response.md deleted file mode 100644 index 4b6b0e1c..00000000 --- a/docs/ReportingV3ChargebackDetailsGet200Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReportingV3ChargebackDetailsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | Organization Id | [optional] -**start_time** | **datetime** | Report Start Date (ISO 8601 Extended) | [optional] -**end_time** | **datetime** | Report Start Date (ISO 8601 Extended) | [optional] -**chargeback_details** | [**list[ReportingV3ChargebackDetailsGet200ResponseChargebackDetails]**](ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md) | List of Chargeback Details list. | [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/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md b/docs/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md deleted file mode 100644 index 7d44d9e2..00000000 --- a/docs/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md +++ /dev/null @@ -1,32 +0,0 @@ -# ReportingV3ChargebackDetailsGet200ResponseChargebackDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**processor_merchant_id** | **str** | Processor Merchant Id | [optional] -**merchant_name** | **str** | Merchant Name | [optional] -**transaction_reference_number** | **str** | Transaction Reference Number | [optional] -**merchant_reference_number** | **str** | Merchant Reference Number | [optional] -**nature_of_dispute** | **str** | Nature of Dispute | [optional] -**alert_type** | **str** | Chargeback Alert Type | [optional] -**amount** | **str** | Chargeback Amount | [optional] -**sign** | **str** | Chargeback Sign | [optional] -**action** | **str** | Chargeback Action | [optional] -**card_type** | **str** | Card Type | [optional] -**original_settlement_time** | **datetime** | Original Settlement Date | [optional] -**tracking_number** | **str** | Tracking Number | [optional] -**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] -**request_id** | **str** | Request Id | [optional] -**response_due_time** | **datetime** | Response Due Date | [optional] -**time** | **datetime** | Chargeback Date | [optional] -**action_description** | **str** | Chargeback Action Description | [optional] -**customer_id** | **str** | Customer Id | [optional] -**reason_code** | **str** | Chargeback Reason Code | [optional] -**representment_cp_time** | **datetime** | Representment CP Date | [optional] -**applications** | **str** | ICS Request Applications | [optional] -**event_requested_time** | **datetime** | Event Request Date | [optional] -**pre_dispute_flag** | **str** | Pre Dispute Flag | [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/ReportingV3ChargebackSummariesGet200Response.md b/docs/ReportingV3ChargebackSummariesGet200Response.md deleted file mode 100644 index 729e54c3..00000000 --- a/docs/ReportingV3ChargebackSummariesGet200Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReportingV3ChargebackSummariesGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | Organization Id | [optional] -**start_time** | **datetime** | Report Start Date | [optional] -**end_time** | **str** | Report Start Date | [optional] -**chargeback_summaries** | [**list[ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries]**](ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md) | List of Summary values | [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/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md b/docs/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md deleted file mode 100644 index 4fd0253a..00000000 --- a/docs/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **float** | Chargeback summary list count | [optional] -**time** | **datetime** | Summary Date | [optional] -**account_id** | **str** | Account 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/ReportingV3ConversionDetailsGet200Response.md b/docs/ReportingV3ConversionDetailsGet200Response.md deleted file mode 100644 index 8b1ee4a0..00000000 --- a/docs/ReportingV3ConversionDetailsGet200Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReportingV3ConversionDetailsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | Merchant Id | [optional] -**start_time** | **datetime** | | [optional] -**end_time** | **datetime** | | [optional] -**conversion_details** | [**list[ReportingV3ConversionDetailsGet200ResponseConversionDetails]**](ReportingV3ConversionDetailsGet200ResponseConversionDetails.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/ReportingV3ConversionDetailsGet200ResponseConversionDetails.md b/docs/ReportingV3ConversionDetailsGet200ResponseConversionDetails.md deleted file mode 100644 index a83748f6..00000000 --- a/docs/ReportingV3ConversionDetailsGet200ResponseConversionDetails.md +++ /dev/null @@ -1,19 +0,0 @@ -# ReportingV3ConversionDetailsGet200ResponseConversionDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_reference_number** | **str** | Merchant reference number of a merchant | [optional] -**conversion_time** | **datetime** | Date of conversion | [optional] -**request_id** | **str** | Cybersource Transation request id | [optional] -**original_decision** | **str** | Original decision | [optional] -**new_decision** | **str** | New decision | [optional] -**reviewer** | **str** | User name of the reviewer | [optional] -**reviewer_comments** | **str** | Comments of the reviewer | [optional] -**queue** | **str** | Name of the queue | [optional] -**profile** | **str** | Name of the profile | [optional] -**notes** | [**list[ReportingV3ConversionDetailsGet200ResponseNotes]**](ReportingV3ConversionDetailsGet200ResponseNotes.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/ReportingV3ConversionDetailsGet200ResponseNotes.md b/docs/ReportingV3ConversionDetailsGet200ResponseNotes.md deleted file mode 100644 index 7ad7bb33..00000000 --- a/docs/ReportingV3ConversionDetailsGet200ResponseNotes.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReportingV3ConversionDetailsGet200ResponseNotes - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**time** | **datetime** | Time of the note added by reviewer | [optional] -**added_by** | **str** | Note added by reviewer | [optional] -**comments** | **str** | Comments given by the reviewer | [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/ReportingV3InterchangeClearingLevelDetailsGet200Response.md b/docs/ReportingV3InterchangeClearingLevelDetailsGet200Response.md deleted file mode 100644 index 1758fdbf..00000000 --- a/docs/ReportingV3InterchangeClearingLevelDetailsGet200Response.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReportingV3InterchangeClearingLevelDetailsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_date** | **datetime** | Valid report Start Date in **ISO 8601 format**. Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | [optional] -**end_date** | **datetime** | Valid report Start Date in **ISO 8601 format**. | [optional] -**interchange_clearing_level_details** | [**list[ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails]**](ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md) | List of InterchangeClearingLevelDetail | [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/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md b/docs/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md deleted file mode 100644 index c5b1ddad..00000000 --- a/docs/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md +++ /dev/null @@ -1,60 +0,0 @@ -# ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | | [optional] -**organization_id** | **str** | | [optional] -**account_id** | **str** | | [optional] -**processor_merchant_id** | **str** | | [optional] -**transaction_reference_number** | **str** | | [optional] -**merchant_reference_number** | **str** | | [optional] -**account_suffix** | **str** | | [optional] -**payment_sub_type** | **str** | | [optional] -**payment_sub_type_description** | **str** | | [optional] -**transaction_time** | **datetime** | | [optional] -**processed_time** | **datetime** | | [optional] -**transaction_type** | **str** | | [optional] -**amount** | **str** | | [optional] -**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] -**price_type** | **str** | | [optional] -**price_amount_one** | **str** | | [optional] -**price_amount_two** | **str** | | [optional] -**re_class** | **str** | | [optional] -**settlement_time** | **datetime** | | [optional] -**settlement_processor** | **str** | | [optional] -**merchant_batch_number** | **str** | | [optional] -**cleared_level** | **str** | | [optional] -**billback_reason_code** | **str** | | [optional] -**billback_reason_description** | **str** | | [optional] -**merchant_priced_level** | **str** | | [optional] -**discount_rate** | **str** | | [optional] -**discount_amount** | **str** | | [optional] -**clearing_rate_amount_one** | **str** | | [optional] -**clearing_rate_amount_two** | **str** | | [optional] -**clearing_rate_amount_three** | **str** | | [optional] -**clearing_rate_currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] -**interchange_amount** | **str** | | [optional] -**billback_amount** | **str** | | [optional] -**settlement_amount** | **str** | | [optional] -**settlement_currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] -**conversion_rate** | **str** | | [optional] -**delta_cost** | **str** | | [optional] -**surcharge_amount** | **str** | | [optional] -**percent_rate_charged** | **str** | | [optional] -**per_transaction_charged** | **str** | | [optional] -**downgrade_reason_code** | **str** | | [optional] -**process_time** | **datetime** | | [optional] -**auth_code** | **str** | | [optional] -**batch_time** | **datetime** | | [optional] -**processor_batch_number** | **str** | | [optional] -**card_indicator** | **str** | | [optional] -**minimum_unit** | **int** | | [optional] -**minimum_unit_currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] -**credit_delta_indicator** | **str** | | [optional] -**fee_category** | **str** | | [optional] -**application_name** | **str** | | [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/ReportingV3NetFundingsGet200Response.md b/docs/ReportingV3NetFundingsGet200Response.md deleted file mode 100644 index 863512b4..00000000 --- a/docs/ReportingV3NetFundingsGet200Response.md +++ /dev/null @@ -1,17 +0,0 @@ -# ReportingV3NetFundingsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_time** | **datetime** | Valid report Start Date in **ISO 8601 format**. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | [optional] -**end_time** | **datetime** | Valid report End Date in **ISO 8601 format** **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | [optional] -**net_funding_summaries** | [**list[ReportingV3NetFundingsGet200ResponseNetFundingSummaries]**](ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md) | List of Netfunding summary objects | [optional] -**total_purchases** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of total purchases currency wise | [optional] -**total_refunds** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of total refunds currency wise | [optional] -**total_fees** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of total fees currency wise | [optional] -**total_chargebacks** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of total chargebacks currency wise | [optional] -**net_total** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of new total currency wise | [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/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md b/docs/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md deleted file mode 100644 index 794faf4a..00000000 --- a/docs/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md +++ /dev/null @@ -1,17 +0,0 @@ -# ReportingV3NetFundingsGet200ResponseNetFundingSummaries - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | Valid values: - PURCHASES - REFUNDS - FEES - CHARGEBACKS | [optional] -**payment_sub_type** | **str** | | [optional] -**conveyed_count** | **int** | | [optional] -**conveyed_amount** | **str** | | [optional] -**settled_count** | **int** | | [optional] -**funded_count** | **int** | | [optional] -**funded_amount** | **str** | | [optional] -**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency 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/ReportingV3NetFundingsGet200ResponseTotalPurchases.md b/docs/ReportingV3NetFundingsGet200ResponseTotalPurchases.md deleted file mode 100644 index 21fab57b..00000000 --- a/docs/ReportingV3NetFundingsGet200ResponseTotalPurchases.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReportingV3NetFundingsGet200ResponseTotalPurchases - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **str** | Valid ISO 4217 ALPHA-3 currency code | -**value** | **str** | | - -[[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/ReportingV3NotificationofChangesGet200Response.md b/docs/ReportingV3NotificationofChangesGet200Response.md deleted file mode 100644 index 6ef1e661..00000000 --- a/docs/ReportingV3NotificationofChangesGet200Response.md +++ /dev/null @@ -1,10 +0,0 @@ -# ReportingV3NotificationofChangesGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**notification_of_changes** | [**list[ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges]**](ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md) | List of Notification Of Change Info values | [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/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md b/docs/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md deleted file mode 100644 index e490b3c2..00000000 --- a/docs/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md +++ /dev/null @@ -1,17 +0,0 @@ -# ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_reference_number** | **str** | Merchant Reference Number | [optional] -**transaction_reference_number** | **str** | Transaction Reference Number | [optional] -**time** | **datetime** | Notification Of Change Date(ISO 8601 Extended) | [optional] -**code** | **str** | Merchant Reference Number | [optional] -**account_type** | **str** | Account Type | [optional] -**routing_number** | **str** | Routing Number | [optional] -**account_number** | **str** | Account Number | [optional] -**consumer_name** | **str** | Consumer Name | [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/ReportingV3PaymentBatchSummariesGet200Response.md b/docs/ReportingV3PaymentBatchSummariesGet200Response.md deleted file mode 100644 index 58ec9ce0..00000000 --- a/docs/ReportingV3PaymentBatchSummariesGet200Response.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReportingV3PaymentBatchSummariesGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_time** | **datetime** | | [optional] -**end_time** | **datetime** | | [optional] -**payment_batch_summaries** | [**list[ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries]**](ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.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/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md b/docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md deleted file mode 100644 index 0ff1f650..00000000 --- a/docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md +++ /dev/null @@ -1,21 +0,0 @@ -# ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency_code** | **str** | | [optional] -**payment_sub_type_description** | **str** | | [optional] -**start_time** | **datetime** | | [optional] -**end_time** | **datetime** | | [optional] -**sales_count** | **int** | | [optional] -**sales_amount** | **str** | | [optional] -**credit_count** | **int** | | [optional] -**credit_amount** | **str** | | [optional] -**account_name** | **str** | | [optional] -**account_id** | **str** | | [optional] -**merchant_id** | **str** | | [optional] -**merchant_name** | **str** | | [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/ReportingV3PurchaseRefundDetailsGet200Response.md b/docs/ReportingV3PurchaseRefundDetailsGet200Response.md deleted file mode 100644 index c562b2a7..00000000 --- a/docs/ReportingV3PurchaseRefundDetailsGet200Response.md +++ /dev/null @@ -1,18 +0,0 @@ -# ReportingV3PurchaseRefundDetailsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**offset** | **int** | | [optional] -**limit** | **int** | | [optional] -**page_results** | **int** | | [optional] -**request_details** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails]**](ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md) | List of Request Info values | [optional] -**settlements** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseSettlements]**](ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md) | List of Settlement Info values | [optional] -**authorizations** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations]**](ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md) | List of Authorization Info values | [optional] -**fee_and_funding_details** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails]**](ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md) | List of Fee Funding Info values | [optional] -**others** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseOthers]**](ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md) | List of Other Info values | [optional] -**settlement_statuses** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses]**](ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md) | List of Settlement Status Info values | [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/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md deleted file mode 100644 index 76f4fae2..00000000 --- a/docs/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md +++ /dev/null @@ -1,17 +0,0 @@ -# ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**transaction_reference_number** | **str** | Authorization Transaction Reference Number | [optional] -**time** | **datetime** | Authorization Date | [optional] -**authorization_request_id** | **str** | Authorization Request Id | [optional] -**amount** | **str** | Authorization Amount | [optional] -**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] -**code** | **str** | Authorization Code | [optional] -**rcode** | **str** | Authorization RCode | [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/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md deleted file mode 100644 index 1c7fd22a..00000000 --- a/docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md +++ /dev/null @@ -1,22 +0,0 @@ -# ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**interchange_per_item_fee** | **str** | interchange Per Item Fee | [optional] -**interchange_description** | **str** | interchange Description | [optional] -**interchange_percentage** | **str** | interchange Percentage | [optional] -**interchange_percentage_amount** | **str** | interchange Percentage Amount | [optional] -**discount_percentage** | **str** | Discount Percentage | [optional] -**discount_amount** | **str** | Discount Amount | [optional] -**discount_per_item_fee** | **str** | Discount Per Item Fee | [optional] -**total_fee** | **str** | Total Fee | [optional] -**fee_currency** | **str** | Fee Currency | [optional] -**dues_assessments** | **str** | Dues Assessments | [optional] -**funding_amount** | **str** | Funding Amount | [optional] -**funding_currency** | **str** | Funding Currency (ISO 4217) | [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/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md deleted file mode 100644 index ec4838bb..00000000 --- a/docs/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md +++ /dev/null @@ -1,16 +0,0 @@ -# ReportingV3PurchaseRefundDetailsGet200ResponseOthers - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**merchant_data1** | **str** | Merchant Defined Data | [optional] -**merchant_data2** | **str** | Merchant Defined Data | [optional] -**merchant_data3** | **str** | Merchant Defined Data | [optional] -**merchant_data4** | **str** | Merchant Defined Data | [optional] -**first_name** | **str** | First Name | [optional] -**last_name** | **str** | Last Name | [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/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md deleted file mode 100644 index ec62329b..00000000 --- a/docs/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md +++ /dev/null @@ -1,15 +0,0 @@ -# ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**cybersource_merchant_id** | **str** | Cybersource Merchant Id | [optional] -**processor_merchant_id** | **str** | Cybersource Processor Merchant Id | [optional] -**group_name** | **str** | Group Name | [optional] -**transaction_reference_number** | **str** | Transaction Reference Number | [optional] -**merchant_reference_number** | **str** | Merchant Reference Number | [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/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md deleted file mode 100644 index 8309a571..00000000 --- a/docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md +++ /dev/null @@ -1,14 +0,0 @@ -# ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**status** | **str** | Settlement Status | [optional] -**settlement_time** | **datetime** | Settlement Date | [optional] -**reason_code** | **str** | ReasonCode | [optional] -**error_text** | **str** | errorText | [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/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md deleted file mode 100644 index 44461954..00000000 --- a/docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md +++ /dev/null @@ -1,22 +0,0 @@ -# ReportingV3PurchaseRefundDetailsGet200ResponseSettlements - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**transaction_type** | **str** | Transaction Type | [optional] -**submission_time** | **datetime** | Submission Date | [optional] -**amount** | **str** | Amount | [optional] -**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] -**payment_method** | **str** | payment method | [optional] -**wallet_type** | **str** | Solution Type (Wallet) | [optional] -**payment_type** | **str** | Payment Type | [optional] -**account_suffix** | **str** | Account Suffix | [optional] -**cybersource_batch_time** | **datetime** | Cybersource Batch Time | [optional] -**cybersource_batch_id** | **str** | Cybersource Batch Id | [optional] -**card_type** | **str** | Card Type | [optional] -**debit_network** | **str** | Debit 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/ReportingV3ReportDefinitionsGet200Response.md b/docs/ReportingV3ReportDefinitionsGet200Response.md deleted file mode 100644 index 40690f6c..00000000 --- a/docs/ReportingV3ReportDefinitionsGet200Response.md +++ /dev/null @@ -1,10 +0,0 @@ -# ReportingV3ReportDefinitionsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**report_definitions** | [**list[ReportingV3ReportDefinitionsGet200ResponseReportDefinitions]**](ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.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/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.md b/docs/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.md deleted file mode 100644 index def78160..00000000 --- a/docs/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.md +++ /dev/null @@ -1,16 +0,0 @@ -# ReportingV3ReportDefinitionsGet200ResponseReportDefinitions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | [optional] -**report_definition_id** | **int** | | Id | Definition Class | | --- | --------------------------------- | | 210 | TransactionRequestClass | | 211 | PaymentBatchDetailClass | | 212 | ExceptionDetailClass | | 213 | ProcessorSettlementDetailClass | | 214 | ProcessorEventsDetailClass | | 215 | FundingDetailClass | | 216 | AgingDetailClass | | 217 | ChargebackAndRetrievalDetailClass | | 218 | DepositDetailClass | | 219 | FeeDetailClass | | 220 | InvoiceSummaryClass | | 221 | PayerAuthDetailClass | | 222 | ConversionDetailClass | | 225 | BillableTransactionsDetailClass | | 270 | JPTransactionDetailClass | | 271 | ServiceFeeDetailClass | | 310 | GatewayTransactionRequestClass | | 400 | DecisionManagerEventDetailClass | | 401 | DecisionManagerDetailClass | | 410 | FeeSummaryClass | | 420 | TaxCalculationClass | | 520 | POSTerminalExceptionClass | | 620 | SubscriptionDetailClass | | [optional] -**report_defintion_name** | **str** | | [optional] -**supported_formats** | **list[str]** | | [optional] -**description** | **str** | | [optional] -**default_settings** | [**ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings**](ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md) | | [optional] -**subscription_type** | **str** | 'The subscription type for which report definition is required. By default the type will be CUSTOM.' Valid Values: - CLASSIC - CUSTOM - STANDARD | [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/ReportingV3ReportDefinitionsNameGet200Response.md b/docs/ReportingV3ReportDefinitionsNameGet200Response.md deleted file mode 100644 index 185dc083..00000000 --- a/docs/ReportingV3ReportDefinitionsNameGet200Response.md +++ /dev/null @@ -1,17 +0,0 @@ -# ReportingV3ReportDefinitionsNameGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | [optional] -**report_definition_id** | **int** | | [optional] -**report_defintion_name** | **str** | | [optional] -**attributes** | [**list[ReportingV3ReportDefinitionsNameGet200ResponseAttributes]**](ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md) | | [optional] -**supported_formats** | **list[str]** | | [optional] -**description** | **str** | | [optional] -**default_settings** | [**ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings**](ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md) | | [optional] -**subscription_type** | **str** | 'The subscription type for which report definition is required. By default the type will be CUSTOM.' Valid Values: - 'CLASSIC' - 'CUSTOM' - 'STANDARD' | [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/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md b/docs/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md deleted file mode 100644 index 3d6cc430..00000000 --- a/docs/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md +++ /dev/null @@ -1,16 +0,0 @@ -# ReportingV3ReportDefinitionsNameGet200ResponseAttributes - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**name** | **str** | | [optional] -**description** | **str** | | [optional] -**filter_type** | **str** | Attribute Filter Type. | [optional] -**default** | **bool** | | [optional] -**required** | **bool** | | [optional] -**supported_type** | **str** | Valid values for the filter. | [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/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md b/docs/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md deleted file mode 100644 index 539ff30c..00000000 --- a/docs/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md +++ /dev/null @@ -1,17 +0,0 @@ -# ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**report_mime_type** | **str** | Report Format Valid values: - application/xml - text/csv | [optional] -**report_frequency** | **str** | Report Frequency Value Valid Values: - DAILY - WEEKLY - MONTHLY - ADHOC | [optional] -**report_name** | **str** | Report Name | [optional] -**timezone** | **str** | Time Zone | [optional] -**start_time** | **str** | Start Time | [optional] -**start_day** | **int** | Start Day | [optional] -**report_filters** | **dict(str, list[str])** | List of filters to apply | [optional] -**report_preferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.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/ReportingV3ReportSubscriptionsGet200Response.md b/docs/ReportingV3ReportSubscriptionsGet200Response.md deleted file mode 100644 index 11fefe22..00000000 --- a/docs/ReportingV3ReportSubscriptionsGet200Response.md +++ /dev/null @@ -1,10 +0,0 @@ -# ReportingV3ReportSubscriptionsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**subscriptions** | [**list[ReportingV3ReportSubscriptionsGet200ResponseSubscriptions]**](ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.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/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md b/docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md deleted file mode 100644 index 421a2221..00000000 --- a/docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md +++ /dev/null @@ -1,23 +0,0 @@ -# ReportingV3ReportSubscriptionsGet200ResponseSubscriptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | Selected Organization Id | [optional] -**report_definition_id** | **str** | Report Definition Id | [optional] -**report_definition_name** | **str** | Report Definition Class | [optional] -**report_mime_type** | **str** | Report Format Valid values: - application/xml - text/csv | [optional] -**report_frequency** | **str** | 'Report Frequency' **NOTE: Do not document USER_DEFINED Frequency field in developer center** Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED | [optional] -**report_interval** | **str** | If the reportFrequency is User-defined, reportInterval should be in **ISO 8601 time format** Please refer the following link to know more about ISO 8601 format.[Rfc Time Format](https://en.wikipedia.org/wiki/ISO_8601#Durations) **Example time format for 2 hours and 30 Mins:** - PT2H30M **NOTE: Do not document reportInterval field in developer center** | [optional] -**report_name** | **str** | Report Name | [optional] -**timezone** | **str** | Time Zone | [optional] -**start_time** | **datetime** | Start Time | [optional] -**start_day** | **int** | Start Day | [optional] -**report_fields** | **list[str]** | List of all fields String values | [optional] -**report_filters** | **dict(str, list[str])** | List of filters to apply | [optional] -**report_preferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.md) | | [optional] -**group_id** | **str** | Id for the selected group. | [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/ReportingV3ReportsGet200Response.md b/docs/ReportingV3ReportsGet200Response.md deleted file mode 100644 index 6e148dde..00000000 --- a/docs/ReportingV3ReportsGet200Response.md +++ /dev/null @@ -1,10 +0,0 @@ -# ReportingV3ReportsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**report_search_results** | [**list[ReportingV3ReportsGet200ResponseReportSearchResults]**](ReportingV3ReportsGet200ResponseReportSearchResults.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/ReportingV3ReportsGet200ResponseLink.md b/docs/ReportingV3ReportsGet200ResponseLink.md deleted file mode 100644 index 9b4da9de..00000000 --- a/docs/ReportingV3ReportsGet200ResponseLink.md +++ /dev/null @@ -1,10 +0,0 @@ -# ReportingV3ReportsGet200ResponseLink - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**report_download** | [**ReportingV3ReportsGet200ResponseLinkReportDownload**](ReportingV3ReportsGet200ResponseLinkReportDownload.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/ReportingV3ReportsGet200ResponseLinkReportDownload.md b/docs/ReportingV3ReportsGet200ResponseLinkReportDownload.md deleted file mode 100644 index 82869790..00000000 --- a/docs/ReportingV3ReportsGet200ResponseLinkReportDownload.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReportingV3ReportsGet200ResponseLinkReportDownload - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | | [optional] -**method** | **str** | | [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/ReportingV3ReportsGet200ResponseReportSearchResults.md b/docs/ReportingV3ReportsGet200ResponseReportSearchResults.md deleted file mode 100644 index 46275602..00000000 --- a/docs/ReportingV3ReportsGet200ResponseReportSearchResults.md +++ /dev/null @@ -1,25 +0,0 @@ -# ReportingV3ReportsGet200ResponseReportSearchResults - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**link** | [**ReportingV3ReportsGet200ResponseLink**](ReportingV3ReportsGet200ResponseLink.md) | | [optional] -**report_definition_id** | **str** | Unique Report Identifier of each report type | [optional] -**report_name** | **str** | Name of the report specified by merchant while creating the report | [optional] -**report_mime_type** | **str** | Format of the report to get generated Valid Values: - application/xml - text/csv | [optional] -**report_frequency** | **str** | Frequency of the report to get generated Valid Values: - DAILY - WEEKLY - MONTHLY - ADHOC | [optional] -**status** | **str** | Status of the report Valid Values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA | [optional] -**report_start_time** | **datetime** | Specifies the report start time in ISO 8601 format | [optional] -**report_end_time** | **datetime** | Specifies the report end time in ISO 8601 format | [optional] -**timezone** | **str** | Time Zone | [optional] -**report_id** | **str** | Unique identifier generated for every reports | [optional] -**organization_id** | **str** | CyberSource Merchant Id | [optional] -**queued_time** | **datetime** | Specifies the time of the report in queued in ISO 8601 format | [optional] -**report_generating_time** | **datetime** | Specifies the time of the report started to generate in ISO 8601 format | [optional] -**report_completed_time** | **datetime** | Specifies the time of the report completed the generation in ISO 8601 format | [optional] -**subscription_type** | **str** | Specifies whether the subscription created is either Custom, Standard or Classic | [optional] -**group_id** | **str** | Id for selected group. | [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/ReportingV3ReportsIdGet200Response.md b/docs/ReportingV3ReportsIdGet200Response.md deleted file mode 100644 index bd60e0dc..00000000 --- a/docs/ReportingV3ReportsIdGet200Response.md +++ /dev/null @@ -1,23 +0,0 @@ -# ReportingV3ReportsIdGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | CyberSource merchant id | [optional] -**report_id** | **str** | Report ID Value | [optional] -**report_definition_id** | **str** | Report definition Id | [optional] -**report_name** | **str** | Report Name | [optional] -**report_mime_type** | **str** | Report Format Valid values: - application/xml - text/csv | [optional] -**report_frequency** | **str** | Report Frequency Value Valid values: - DAILY - WEEKLY - MONTHLY - ADHOC | [optional] -**report_fields** | **list[str]** | List of Integer Values | [optional] -**report_status** | **str** | Report Status Value Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA - RERUN | [optional] -**report_start_time** | **datetime** | Report Start Time Value | [optional] -**report_end_time** | **datetime** | Report End Time Value | [optional] -**timezone** | **str** | Time Zone Value | [optional] -**report_filters** | **dict(str, list[str])** | List of filters to apply | [optional] -**report_preferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.md) | | [optional] -**group_id** | **str** | Id for selected group. | [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/ReportingV3RetrievalDetailsGet200Response.md b/docs/ReportingV3RetrievalDetailsGet200Response.md deleted file mode 100644 index 2adbe4c6..00000000 --- a/docs/ReportingV3RetrievalDetailsGet200Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReportingV3RetrievalDetailsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | Organization Id | [optional] -**start_time** | **datetime** | Report Start Date (ISO 8601 Extended) | [optional] -**end_time** | **datetime** | Report Start Date (ISO 8601 Extended) | [optional] -**retrieval_details** | [**list[ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails]**](ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md) | List of Retrieval Details list. | [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/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md b/docs/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md deleted file mode 100644 index 79bd3ce2..00000000 --- a/docs/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md +++ /dev/null @@ -1,31 +0,0 @@ -# ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**processor_merchant_id** | **str** | Processor Merchant Id | [optional] -**merchant_name** | **str** | Merchant Name | [optional] -**transaction_reference_number** | **str** | Transaction Reference Number | [optional] -**merchant_reference_number** | **str** | Merchant Reference Number | [optional] -**nature_of_dispute** | **str** | Nature of Dispute | [optional] -**alert_type** | **str** | Retrieval Alert Type | [optional] -**amount** | **str** | Retrieval Amount | [optional] -**sign** | **str** | Retrieval Sign | [optional] -**action** | **str** | Retrieval Action | [optional] -**card_type** | **str** | Card Type | [optional] -**original_settlement_time** | **datetime** | Original Settlement Date | [optional] -**tracking_number** | **str** | Tracking Number | [optional] -**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] -**request_id** | **str** | Request Id | [optional] -**response_due_time** | **datetime** | Response Due Date | [optional] -**time** | **datetime** | Retrieval Date | [optional] -**action_description** | **str** | Retrieval Action Description | [optional] -**customer_id** | **str** | Customer Id | [optional] -**reason_code** | **str** | Retrieval Reason Code | [optional] -**representment_cp_time** | **datetime** | Representment CP Date | [optional] -**applications** | **str** | ICS Request Applications | [optional] -**event_requested_time** | **datetime** | Event Request Date | [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/ReportingV3RetrievalSummariesGet200Response.md b/docs/ReportingV3RetrievalSummariesGet200Response.md deleted file mode 100644 index c684d111..00000000 --- a/docs/ReportingV3RetrievalSummariesGet200Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReportingV3RetrievalSummariesGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | Organization Id | [optional] -**start_time** | **datetime** | Report Start Date | [optional] -**end_time** | **str** | Report Start Date | [optional] -**retrieval_summaries** | [**list[ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries]**](ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md) | List of Summary values | [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/Reportingv3ReportDownloadsGet400Response.md b/docs/Reportingv3ReportDownloadsGet400Response.md deleted file mode 100644 index 4530b58a..00000000 --- a/docs/Reportingv3ReportDownloadsGet400Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# Reportingv3ReportDownloadsGet400Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submit_time_utc** | **datetime** | Time of request in UTC. | -**reason** | **str** | Documented reason code | -**message** | **str** | Short descriptive message to the user. | -**details** | [**list[Reportingv3ReportDownloadsGet400ResponseDetails]**](Reportingv3ReportDownloadsGet400ResponseDetails.md) | Error field list | - -[[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/Reportingv3ReportDownloadsGet400ResponseDetails.md b/docs/Reportingv3ReportDownloadsGet400ResponseDetails.md deleted file mode 100644 index 54a45676..00000000 --- a/docs/Reportingv3ReportDownloadsGet400ResponseDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# Reportingv3ReportDownloadsGet400ResponseDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**field** | **str** | Field in request that caused an error | [optional] -**reason** | **str** | Documented reason 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/Reportingv3reportsReportFilters.md b/docs/Reportingv3reportsReportFilters.md deleted file mode 100644 index 7b18aee8..00000000 --- a/docs/Reportingv3reportsReportFilters.md +++ /dev/null @@ -1,13 +0,0 @@ -# Reportingv3reportsReportFilters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**application_name** | **list[str]** | | [optional] -**first_name** | **list[str]** | | [optional] -**last_name** | **list[str]** | | [optional] -**email** | **list[str]** | | [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/Reportingv3reportsReportPreferences.md b/docs/Reportingv3reportsReportPreferences.md deleted file mode 100644 index 2ec28cf6..00000000 --- a/docs/Reportingv3reportsReportPreferences.md +++ /dev/null @@ -1,11 +0,0 @@ -# Reportingv3reportsReportPreferences - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**signed_amounts** | **bool** | Indicator to determine whether negative sign infront of amount for all refunded transaction | [optional] -**field_name_convention** | **str** | Specify the field naming convention to be followed in reports (applicable to only csv report formats) Valid values: - SOAPI - SCMP | [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/ReportsApi.md b/docs/ReportsApi.md deleted file mode 100644 index cd7df787..00000000 --- a/docs/ReportsApi.md +++ /dev/null @@ -1,174 +0,0 @@ -# CyberSource.ReportsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_report**](ReportsApi.md#create_report) | **POST** /reporting/v3/reports | Create Adhoc Report -[**get_report_by_report_id**](ReportsApi.md#get_report_by_report_id) | **GET** /reporting/v3/reports/{reportId} | Get Report Based on Report Id -[**search_reports**](ReportsApi.md#search_reports) | **GET** /reporting/v3/reports | Retrieve Available Reports - - -# **create_report** -> create_report(create_adhoc_report_request, organization_id=organization_id) - -Create Adhoc Report - -Create a one-time report. You must specify the type of report in reportDefinitionName. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation) - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportsApi() -create_adhoc_report_request = CyberSource.CreateAdhocReportRequest() # CreateAdhocReportRequest | Report subscription request payload -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Create Adhoc Report - api_instance.create_report(create_adhoc_report_request, organization_id=organization_id) -except ApiException as e: - print("Exception when calling ReportsApi->create_report: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **create_adhoc_report_request** | [**CreateAdhocReportRequest**](CreateAdhocReportRequest.md)| Report subscription request payload | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_report_by_report_id** -> ReportingV3ReportsIdGet200Response get_report_by_report_id(report_id, organization_id=organization_id) - -Get Report Based on Report Id - -Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportsApi() -report_id = 'report_id_example' # str | Valid Report Id -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Get Report Based on Report Id - api_response = api_instance.get_report_by_report_id(report_id, organization_id=organization_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ReportsApi->get_report_by_report_id: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_id** | **str**| Valid Report Id | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -[**ReportingV3ReportsIdGet200Response**](ReportingV3ReportsIdGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json, application/xml - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_reports** -> ReportingV3ReportsGet200Response search_reports(start_time, end_time, time_query_type, organization_id=organization_id, report_mime_type=report_mime_type, report_frequency=report_frequency, report_name=report_name, report_definition_id=report_definition_id, report_status=report_status) - -Retrieve Available Reports - -Retrieve a list of the available reports to which you are subscribed. This will also give you the reportId value, which you can also use to download a report. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReportsApi() -start_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) -end_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) -time_query_type = 'time_query_type_example' # str | Specify time you would like to search Valid values: - reportTimeFrame - executedTime -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) -report_mime_type = 'report_mime_type_example' # str | Valid Report Format Valid values: - application/xml - text/csv (optional) -report_frequency = 'report_frequency_example' # str | Valid Report Frequency Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED - ADHOC (optional) -report_name = 'report_name_example' # str | Valid Report Name (optional) -report_definition_id = 56 # int | Valid Report Definition Id (optional) -report_status = 'report_status_example' # str | Valid Report Status Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA (optional) - -try: - # Retrieve Available Reports - api_response = api_instance.search_reports(start_time, end_time, time_query_type, organization_id=organization_id, report_mime_type=report_mime_type, report_frequency=report_frequency, report_name=report_name, report_definition_id=report_definition_id, report_status=report_status) - pprint(api_response) -except ApiException as e: - print("Exception when calling ReportsApi->search_reports: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_time** | **datetime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | - **end_time** | **datetime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | - **time_query_type** | **str**| Specify time you would like to search Valid values: - reportTimeFrame - executedTime | - **organization_id** | **str**| Valid Organization Id | [optional] - **report_mime_type** | **str**| Valid Report Format Valid values: - application/xml - text/csv | [optional] - **report_frequency** | **str**| Valid Report Frequency Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED - ADHOC | [optional] - **report_name** | **str**| Valid Report Name | [optional] - **report_definition_id** | **int**| Valid Report Definition Id | [optional] - **report_status** | **str**| Valid Report Status Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA | [optional] - -### Return type - -[**ReportingV3ReportsGet200Response**](ReportingV3ReportsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Request.md b/docs/Request.md deleted file mode 100644 index 78ee2203..00000000 --- a/docs/Request.md +++ /dev/null @@ -1,11 +0,0 @@ -# Request - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**processing_information** | [**Ptsv2paymenttokensProcessingInformation**](Ptsv2paymenttokensProcessingInformation.md) | | [optional] -**payment_information** | [**Ptsv2paymenttokensPaymentInformation**](Ptsv2paymenttokensPaymentInformation.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/ResourceNotFoundError.md b/docs/ResourceNotFoundError.md deleted file mode 100644 index 9def414e..00000000 --- a/docs/ResourceNotFoundError.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResourceNotFoundError - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | **str** | | [optional] -**error_description** | **str** | | [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/RetrievalDetailsApi.md b/docs/RetrievalDetailsApi.md deleted file mode 100644 index e12bad3a..00000000 --- a/docs/RetrievalDetailsApi.md +++ /dev/null @@ -1,61 +0,0 @@ -# CyberSource.RetrievalDetailsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_retrieval_details**](RetrievalDetailsApi.md#get_retrieval_details) | **GET** /reporting/v3/retrieval-details | Get Retrieval Details - - -# **get_retrieval_details** -> ReportingV3RetrievalDetailsGet200Response get_retrieval_details(start_time, end_time, organization_id=organization_id) - -Get Retrieval Details - -Retrieval Detail Report Description - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.RetrievalDetailsApi() -start_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) -end_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Get Retrieval Details - api_response = api_instance.get_retrieval_details(start_time, end_time, organization_id=organization_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling RetrievalDetailsApi->get_retrieval_details: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_time** | **datetime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | - **end_time** | **datetime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -[**ReportingV3RetrievalDetailsGet200Response**](ReportingV3RetrievalDetailsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json, application/xml - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/RetrievalSummariesApi.md b/docs/RetrievalSummariesApi.md deleted file mode 100644 index 1467dbce..00000000 --- a/docs/RetrievalSummariesApi.md +++ /dev/null @@ -1,61 +0,0 @@ -# CyberSource.RetrievalSummariesApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_retrieval_summary**](RetrievalSummariesApi.md#get_retrieval_summary) | **GET** /reporting/v3/retrieval-summaries | Get Retrieval Summaries - - -# **get_retrieval_summary** -> ReportingV3RetrievalSummariesGet200Response get_retrieval_summary(start_time, end_time, organization_id=organization_id) - -Get Retrieval Summaries - -Retrieval Summary Report Description - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.RetrievalSummariesApi() -start_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) -end_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) -organization_id = 'organization_id_example' # str | Valid Organization Id (optional) - -try: - # Get Retrieval Summaries - api_response = api_instance.get_retrieval_summary(start_time, end_time, organization_id=organization_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling RetrievalSummariesApi->get_retrieval_summary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_time** | **datetime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | - **end_time** | **datetime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | - **organization_id** | **str**| Valid Organization Id | [optional] - -### Return type - -[**ReportingV3RetrievalSummariesGet200Response**](ReportingV3RetrievalSummariesGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json, application/xml - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/ReversalApi.md b/docs/ReversalApi.md deleted file mode 100644 index 2940240c..00000000 --- a/docs/ReversalApi.md +++ /dev/null @@ -1,108 +0,0 @@ -# CyberSource.ReversalApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**auth_reversal**](ReversalApi.md#auth_reversal) | **POST** /pts/v2/payments/{id}/reversals | Process an Authorization Reversal -[**mit_reversal**](ReversalApi.md#mit_reversal) | **POST** /pts/v2/reversals | Timeout Reversal - - -# **auth_reversal** -> PtsV2PaymentsReversalsPost201Response auth_reversal(id, auth_reversal_request) - -Process an Authorization Reversal - -Include the payment ID in the POST request to reverse the payment amount. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReversalApi() -id = 'id_example' # str | The payment ID returned from a previous payment request. -auth_reversal_request = CyberSource.AuthReversalRequest() # AuthReversalRequest | - -try: - # Process an Authorization Reversal - api_response = api_instance.auth_reversal(id, auth_reversal_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling ReversalApi->auth_reversal: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| The payment ID returned from a previous payment request. | - **auth_reversal_request** | [**AuthReversalRequest**](AuthReversalRequest.md)| | - -### Return type - -[**PtsV2PaymentsReversalsPost201Response**](PtsV2PaymentsReversalsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **mit_reversal** -> PtsV2PaymentsReversalsPost201Response mit_reversal(mit_reversal_request) - -Timeout Reversal - -This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.ReversalApi() -mit_reversal_request = CyberSource.MitReversalRequest() # MitReversalRequest | - -try: - # Timeout Reversal - api_response = api_instance.mit_reversal(mit_reversal_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling ReversalApi->mit_reversal: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **mit_reversal_request** | [**MitReversalRequest**](MitReversalRequest.md)| | - -### Return type - -[**PtsV2PaymentsReversalsPost201Response**](PtsV2PaymentsReversalsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/RiskProducts.md b/docs/RiskProducts.md deleted file mode 100644 index 0e51a563..00000000 --- a/docs/RiskProducts.md +++ /dev/null @@ -1,12 +0,0 @@ -# RiskProducts - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fraud_management_essentials** | [**RiskProductsFraudManagementEssentials**](RiskProductsFraudManagementEssentials.md) | | [optional] -**decision_manager** | [**RiskProductsDecisionManager**](RiskProductsDecisionManager.md) | | [optional] -**portfolio_risk_controls** | [**RiskProductsPortfolioRiskControls**](RiskProductsPortfolioRiskControls.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/RiskProductsDecisionManager.md b/docs/RiskProductsDecisionManager.md deleted file mode 100644 index 6173ba80..00000000 --- a/docs/RiskProductsDecisionManager.md +++ /dev/null @@ -1,11 +0,0 @@ -# RiskProductsDecisionManager - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**subscription_information** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional] -**configuration_information** | [**RiskProductsDecisionManagerConfigurationInformation**](RiskProductsDecisionManagerConfigurationInformation.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/RiskProductsDecisionManagerConfigurationInformation.md b/docs/RiskProductsDecisionManagerConfigurationInformation.md deleted file mode 100644 index f4204797..00000000 --- a/docs/RiskProductsDecisionManagerConfigurationInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# RiskProductsDecisionManagerConfigurationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**template_id** | **str** | | [optional] -**configurations** | [**DmConfig**](DmConfig.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/RiskProductsFraudManagementEssentials.md b/docs/RiskProductsFraudManagementEssentials.md deleted file mode 100644 index 9af12224..00000000 --- a/docs/RiskProductsFraudManagementEssentials.md +++ /dev/null @@ -1,11 +0,0 @@ -# RiskProductsFraudManagementEssentials - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**subscription_information** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional] -**configuration_information** | [**RiskProductsFraudManagementEssentialsConfigurationInformation**](RiskProductsFraudManagementEssentialsConfigurationInformation.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/RiskProductsFraudManagementEssentialsConfigurationInformation.md b/docs/RiskProductsFraudManagementEssentialsConfigurationInformation.md deleted file mode 100644 index 76e4eb33..00000000 --- a/docs/RiskProductsFraudManagementEssentialsConfigurationInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# RiskProductsFraudManagementEssentialsConfigurationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**template_id** | **str** | | [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/RiskProductsPortfolioRiskControls.md b/docs/RiskProductsPortfolioRiskControls.md deleted file mode 100644 index 2f664f9d..00000000 --- a/docs/RiskProductsPortfolioRiskControls.md +++ /dev/null @@ -1,11 +0,0 @@ -# RiskProductsPortfolioRiskControls - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**subscription_information** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional] -**configuration_information** | [**RiskProductsPortfolioRiskControlsConfigurationInformation**](RiskProductsPortfolioRiskControlsConfigurationInformation.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/RiskProductsPortfolioRiskControlsConfigurationInformation.md b/docs/RiskProductsPortfolioRiskControlsConfigurationInformation.md deleted file mode 100644 index 5c3a43dd..00000000 --- a/docs/RiskProductsPortfolioRiskControlsConfigurationInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# RiskProductsPortfolioRiskControlsConfigurationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**configurations** | [**RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations**](RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.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/RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.md b/docs/RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.md deleted file mode 100644 index 50276635..00000000 --- a/docs/RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.md +++ /dev/null @@ -1,10 +0,0 @@ -# RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**profile_id** | **str** | | [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/RiskV1AddressVerificationsPost201Response.md b/docs/RiskV1AddressVerificationsPost201Response.md deleted file mode 100644 index 3daa1d5d..00000000 --- a/docs/RiskV1AddressVerificationsPost201Response.md +++ /dev/null @@ -1,18 +0,0 @@ -# RiskV1AddressVerificationsPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**submit_time_local** | **str** | Time that the transaction was submitted in local time. Generated by Cybersource. | [optional] -**status** | **str** | The status for the call can be: - COMPLETED - INVALID_REQUEST - DECLINED | [optional] -**message** | **str** | The message describing the reason of the status. Value can be - Apartment number missing or not found. - Insufficient address information. - House/Box number not found on street. - Multiple address matches were found. - P.O. Box identifier not found or out of range. - Route service identifier not found or out of range. - Street name not found in Postal code. - Postal code not found in database. - Unable to verify or correct address. - Multiple addres matches were found (international) - Address match not found (no reason given) - Unsupported character set | [optional] -**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] -**address_verification_information** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md) | | [optional] -**error_information** | [**RiskV1AddressVerificationsPost201ResponseErrorInformation**](RiskV1AddressVerificationsPost201ResponseErrorInformation.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/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md deleted file mode 100644 index 4c3e659c..00000000 --- a/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md +++ /dev/null @@ -1,17 +0,0 @@ -# RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address_type** | **str** | 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] -**bar_code** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md) | | [optional] -**applicable_region** | **str** | 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] -**error_code** | **str** | 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] -**status_code** | **str** | Four-to-ten character status 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] -**care_of** | **str** | Care of data dropped from the standard address. | [optional] -**match_score** | **int** | Indicates the probable correctness of the address match. Returned for U.S. and Canadian addresses. Returns a value from 0-9, where 0 is most likely to be correct and 9 is least likely to be correct, or -1 if there is no address match. | [optional] -**standard_address** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.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/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md deleted file mode 100644 index a897c01e..00000000 --- a/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md +++ /dev/null @@ -1,11 +0,0 @@ -# RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | **str** | Delivery point bar code determined from the input address. | [optional] -**check_digit** | **float** | Check digit for the 11-digit delivery point bar 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/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.md deleted file mode 100644 index 3e8b0f7a..00000000 --- a/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.md +++ /dev/null @@ -1,20 +0,0 @@ -# RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md) | | [optional] -**address2** | **str** | Second line of the standardized address. | [optional] -**address3** | **str** | Third line of the standardized address. | [optional] -**address4** | **str** | Fourth line of the standardized address. | [optional] -**locality** | **str** | Standardized city name. | [optional] -**county** | **str** | U.S. county if available. | [optional] -**country** | **str** | Standardized country name. | [optional] -**csz** | **str** | Standardized city, state or province, and ZIP +4 code or postal code line. | [optional] -**iso_country** | **str** | Standardized two-character ISO country code. | [optional] -**administrative_area** | **str** | U.S.P.S. standardized state or province abbreviation. | [optional] -**postal_code** | **str** | Standardized U.S. ZIP + 4 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/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md deleted file mode 100644 index 52d80fd9..00000000 --- a/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md +++ /dev/null @@ -1,11 +0,0 @@ -# RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**with_apartment** | **str** | First line of the standardized address, including apartment information. | [optional] -**without_apartment** | **str** | First line of the standardized address, without apartment information. Returned for U.S. and Canadian addresses. | [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/RiskV1AddressVerificationsPost201ResponseErrorInformation.md b/docs/RiskV1AddressVerificationsPost201ResponseErrorInformation.md deleted file mode 100644 index 4ccb7ef7..00000000 --- a/docs/RiskV1AddressVerificationsPost201ResponseErrorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# RiskV1AddressVerificationsPost201ResponseErrorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | The reason of the status. Value can be - `APARTMENT_NUMBER_NOT_FOUND` - `INSUFFICIENT_ADDRESS_INFORMATION` - `HOUSE_OR_BOX_NUMBER_NOT_FOUND` - `MULTIPLE_ADDRESS_MATCHES` - `BOX_NUMBER_NOT_FOUND` - `ROUTE_SERVICE_NOT_FOUND` - `STREET_NAME_NOT_FOUND` - `POSTAL_CODE_NOT_FOUND` - `UNVERIFIABLE_ADDRESS` - `MULTIPLE_ADDRESS_MATCHES_INTERNATIONAL` - `ADDRESS_MATCH_NOT_FOUND` - `UNSUPPORTED_CHARACTER_SET` - `INVALID_MERCHANT_CONFIGURATION` | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1AuthenticationResultsPost201Response.md b/docs/RiskV1AuthenticationResultsPost201Response.md deleted file mode 100644 index 847b7e82..00000000 --- a/docs/RiskV1AuthenticationResultsPost201Response.md +++ /dev/null @@ -1,17 +0,0 @@ -# RiskV1AuthenticationResultsPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `AUTHENTICATION_FAILED` | [optional] -**message** | **str** | The message describing the reason of the status. Value is: - The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction. | [optional] -**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] -**consumer_authentication_information** | [**RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation**](RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md) | | [optional] -**error_information** | [**RiskV1AuthenticationsPost201ResponseErrorInformation**](RiskV1AuthenticationsPost201ResponseErrorInformation.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/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md deleted file mode 100644 index 89a2cf89..00000000 --- a/docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md +++ /dev/null @@ -1,40 +0,0 @@ -# RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**acs_rendering_type** | **str** | Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. | [optional] -**acs_reference_number** | **str** | Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval. | [optional] -**acs_transaction_id** | **str** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional] -**acs_operator_id** | **str** | Directory Server assigned ACS identifier. | [optional] -**authentication_result** | **str** | Raw authentication data that comes from the cardissuing bank. Primary authentication field that indicates if authentication was successful and if liability shift occurred. You should examine first the result of this field. This field contains one of these values: - `-1`: Invalid PARes. - `0`: Successful validation. - `1`: Cardholder is not participating, but the attempt to authenticate was recorded. - `6`: Issuer unable to perform authentication. - `9`: Cardholder did not complete authentication. | [optional] -**authentication_type** | **str** | 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] -**authentication_status_msg** | **str** | Message that explains the authenticationResult reply field. | [optional] -**authentication_transaction_id** | **str** | 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] -**authentication_transaction_context_id** | **str** | Payer authentication transaction identifier passed to link the validation and authorization calls. | [optional] -**transaction_token** | **str** | Web based token used to authenticate consumer with Rupay authentication provider. | [optional] -**authorization_payload** | **str** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional] -**cavv** | **str** | Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor. | [optional] -**cavv_algorithm** | **str** | Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard | [optional] -**challenge_cancel_code** | **str** | 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] -**directory_server_error_code** | **str** | The directory server error code indicating a problem with this transaction. Note - Max Length of this field is typically 3 characters. | [optional] -**directory_server_error_description** | **str** | Directory server text and additional detail about the error for this transaction. | [optional] -**effective_authentication_type** | **str** | This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer). | [optional] -**indicator** | **str** | Indicator used to differentiate Internet transactions from other types. The authentication failed if this field is not returned. For Visa, if your payment processor is Streamline, Barclays, AIBMS, or FDC Germany, you receive the value vbv_failure instead of internet when eci is 07. The value of this field is passed automatically to the authorization service if you request the services together. This field contains one of these values: - `aesk`: American Express SafeKey authentication verified successfully. - `aesk_attempted`: Card not enrolled in American Express SafeKey, but the attempt to authenticate was recorded. - `dipb`: Discover ProtectBuy authentication verified successfully. - `dipb_attempted`: Card not enrolled in Discover ProtectBuy, but the attempt to authenticate was recorded. - `internet`: Authentication was not verified successfully. - `js`: J/Secure authentication verified successfully. - `js_attempted`: Card not enrolled in J/Secure, but the attempt to authenticate was recorded. - `moto`: Mail or telephone order. - `pb_attempted`: Card not enrolled in Diners Club ProtectBuy, but the attempt to authenticate was recorded. - `recurring`: Recurring transaction. - `spa`: Mastercard Identity Check authentication verified successfully. - `spa_failure`: Mastercard Identity Check failed authentication. - `vbv`: Visa Secure authentication verified successfully. - `vbv_attempted`: Card not enrolled in Visa Secure, but the attempt to authenticate was recorded. - `vbv_failure`: Visa Secure authentication unavailable. | [optional] -**interaction_counter** | **str** | Indicates the number of authentication cycles attempted by the cardholder and is tracked by the Issuing Banks ACS.Example: if customer gets the challenge window and enter in their one time password and hit submit then that interaction counter should just be 1. When customer gets the challenge window and the bank asks if they want to have the one time password sent to their phone or their email and they have to choose before going to the next screen to enter in their one time password then this interaction count would be 2. One for the selection of how they want the one time password delivered and another with them actually entering in the one time password and hitting the submit button. | [optional] -**eci** | **str** | Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see \"Interpreting the Reply,\" page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.) | [optional] -**eci_raw** | **str** | ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of `eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover) | [optional] -**pares_status** | **str** | 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] -**sdk_transaction_id** | **str** | SDK unique transaction identifier that is generated on each new transaction. | [optional] -**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 | [optional] -**three_ds_server_transaction_id** | **str** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] -**ucaf_authentication_data** | **str** | 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] -**ucaf_collection_indicator** | **str** | 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] -**white_list_status** | **str** | Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder | [optional] -**white_list_status_source** | **str** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional] -**xid** | **str** | 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] -**directory_server_transaction_id** | **str** | 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] - -[[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/RiskV1AuthenticationSetupsPost201Response.md b/docs/RiskV1AuthenticationSetupsPost201Response.md deleted file mode 100644 index 47e786ea..00000000 --- a/docs/RiskV1AuthenticationSetupsPost201Response.md +++ /dev/null @@ -1,16 +0,0 @@ -# RiskV1AuthenticationSetupsPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status for payerAuthentication 201 setup calls. Possible value is: - COMPLETED - FAILED | [optional] -**consumer_authentication_information** | [**RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation**](RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md) | | [optional] -**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] -**error_information** | [**RiskV1AuthenticationSetupsPost201ResponseErrorInformation**](RiskV1AuthenticationSetupsPost201ResponseErrorInformation.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/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md deleted file mode 100644 index b42ce46b..00000000 --- a/docs/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | JSON Web Token (JWT) used to authenticate the consumer with the authentication provider, such as, CardinalCommerce or Rupay. Note - Max Length of this field is 2048 characters. | [optional] -**reference_id** | **str** | This identifier represents cardinal has started device data collection session and this must be passed in Authentication JWT to Cardinal when invoking the deviceDataCollectionUrl. | [optional] -**device_data_collection_url** | **str** | The deviceDataCollectionUrl is the location to send the Authentication JWT when invoking the Device Data collection process. | [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/RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md b/docs/RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md deleted file mode 100644 index eaa3f4e2..00000000 --- a/docs/RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# RiskV1AuthenticationSetupsPost201ResponseErrorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | The reason of the status. Possible values: - EXPIRED_CARD - GENERAL_DECLINE | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1AuthenticationsPost201Response.md b/docs/RiskV1AuthenticationsPost201Response.md deleted file mode 100644 index be9da0df..00000000 --- a/docs/RiskV1AuthenticationsPost201Response.md +++ /dev/null @@ -1,18 +0,0 @@ -# RiskV1AuthenticationsPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `AUTHENTICATION_FAILED` | [optional] -**message** | **str** | The message describing the reason of the status. Value is: - The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction. | [optional] -**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] -**order_information** | [**RiskV1DecisionsPost201ResponseOrderInformation**](RiskV1DecisionsPost201ResponseOrderInformation.md) | | [optional] -**consumer_authentication_information** | [**RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation**](RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md) | | [optional] -**error_information** | [**RiskV1AuthenticationsPost201ResponseErrorInformation**](RiskV1AuthenticationsPost201ResponseErrorInformation.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/RiskV1AuthenticationsPost201ResponseErrorInformation.md b/docs/RiskV1AuthenticationsPost201ResponseErrorInformation.md deleted file mode 100644 index c60209a6..00000000 --- a/docs/RiskV1AuthenticationsPost201ResponseErrorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# RiskV1AuthenticationsPost201ResponseErrorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | The reason of the status. Possible values are: - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_REQUIRED` - `CONSUMER_AUTHENTICATION_FAILED` - `AUTHENTICATION_FAILED` | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1AuthenticationsPost400Response.md b/docs/RiskV1AuthenticationsPost400Response.md deleted file mode 100644 index dbd46b69..00000000 --- a/docs/RiskV1AuthenticationsPost400Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# RiskV1AuthenticationsPost400Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status for payerAuthentication 400 setup calls. Possible values are: - INVALID_REQUEST | [optional] -**reason** | **str** | The reason of the status. | [optional] -**message** | **str** | The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be setup. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1AuthenticationsPost400Response1.md b/docs/RiskV1AuthenticationsPost400Response1.md deleted file mode 100644 index 43cc4188..00000000 --- a/docs/RiskV1AuthenticationsPost400Response1.md +++ /dev/null @@ -1,14 +0,0 @@ -# RiskV1AuthenticationsPost400Response1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status for payerAuthentication 400 enroll and validate calls. Value is: - `INVALID_REQUEST` | [optional] -**reason** | **str** | The reason of the status. Possible Values: - `MISSING_FIELD` - `INVALID_DATA` | [optional] -**message** | **str** | The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be authenticated. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1DecisionsPost201Response.md b/docs/RiskV1DecisionsPost201Response.md deleted file mode 100644 index a0ad045f..00000000 --- a/docs/RiskV1DecisionsPost201Response.md +++ /dev/null @@ -1,21 +0,0 @@ -# RiskV1DecisionsPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2PaymentsPost201ResponseLinks**](PtsV2PaymentsPost201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**submit_time_local** | **str** | Time that the transaction was submitted in local time. Generated by Cybersource. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - `ACCEPTED` - `REJECTED` - `PENDING_REVIEW` - `DECLINED` - `PENDING_AUTHENTICATION` - `INVALID_REQUEST` - `AUTHENTICATION_FAILED` - `CHALLENGE` | [optional] -**risk_information** | [**PtsV2PaymentsPost201ResponseRiskInformation**](PtsV2PaymentsPost201ResponseRiskInformation.md) | | [optional] -**payment_information** | [**RiskV1DecisionsPost201ResponsePaymentInformation**](RiskV1DecisionsPost201ResponsePaymentInformation.md) | | [optional] -**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] -**order_information** | [**RiskV1DecisionsPost201ResponseOrderInformation**](RiskV1DecisionsPost201ResponseOrderInformation.md) | | [optional] -**consumer_authentication_information** | [**RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation**](RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md) | | [optional] -**watchlist_screening_information** | [**PtsV2PaymentsPost201ResponseWatchlistScreeningInformation**](PtsV2PaymentsPost201ResponseWatchlistScreeningInformation.md) | | [optional] -**error_information** | [**RiskV1DecisionsPost201ResponseErrorInformation**](RiskV1DecisionsPost201ResponseErrorInformation.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/RiskV1DecisionsPost201ResponseClientReferenceInformation.md b/docs/RiskV1DecisionsPost201ResponseClientReferenceInformation.md deleted file mode 100644 index 1e84773a..00000000 --- a/docs/RiskV1DecisionsPost201ResponseClientReferenceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# RiskV1DecisionsPost201ResponseClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | 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** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**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/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md deleted file mode 100644 index 229470d5..00000000 --- a/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md +++ /dev/null @@ -1,55 +0,0 @@ -# RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | JSON Web Token (JWT) used to authenticate the consumer with the authentication provider, such as, CardinalCommerce or Rupay. Note - Max Length of this field is 2048 characters. | [optional] -**acs_rendering_type** | **str** | Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. | [optional] -**acs_transaction_id** | **str** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional] -**acs_url** | **str** | URL for the card-issuing bank's authentication form that you receive when the card is enrolled. The value can be very large. | [optional] -**authentication_path** | **str** | 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] -**authorization_payload** | **str** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional] -**authentication_type** | **str** | 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] -**authentication_transaction_id** | **str** | 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] -**authentication_transaction_context_id** | **str** | Payer authentication transaction identifier passed to link the validation and authorization calls. | [optional] -**validity_period** | **int** | Describes validity of OTP in minutes for incoming transaction. . | [optional] -**cardholder_message** | **str** | 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] -**cavv** | **str** | Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor. | [optional] -**cavv_algorithm** | **str** | Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard | [optional] -**challenge_cancel_code** | **str** | 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] -**challenge_required** | **str** | Indicates whether a challenge is required in order to complete authentication. **Note** Regional mandates might determine that a challenge is required. Possible values: - `Y`: Challenge required - `N`: Challenge not required **Note** Used by the Hybrid integration. | [optional] -**decoupled_authentication_indicator** | **str** | 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] -**directory_server_error_code** | **str** | The directory server error code indicating a problem with this transaction. Note - Max Length of this field is typically 3 characters. | [optional] -**directory_server_error_description** | **str** | Directory server text and additional detail about the error for this transaction. | [optional] -**ecommerce_indicator** | **str** | Commerce indicator for cards not enrolled. This field contains one of these values: - `internet`: Card not enrolled, or card type not supported by payer authentication. No liability shift. - `js_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `js_failure`: J/Secure directory service is not available. No liability shift. - `spa`: Mastercard card not enrolled in the SecureCode program. No liability shift. - `vbv_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `vbv_failure`: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive this result if Visa's directory service is not available. No liability shift. | [optional] -**eci** | **str** | Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see \"Interpreting the Reply,\" page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.) | [optional] -**eci_raw** | **str** | ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of `eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover) | [optional] -**effective_authentication_type** | **str** | This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer). | [optional] -**exemption_data_raw** | **str** | Payer authentication exemption indicator for Carte Bancaire exemptions. This is used with unbundled authentication and authorizations calls, for example: \"low fraud merchant program\". The value returned in this field should be passed in the authorization request under the field - `consumerAuthenticationInformation.strongAuthentication.issuerInformation.exemptionDataRaw`. | [optional] -**ivr** | [**PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr**](PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr.md) | | [optional] -**network_score** | **str** | The global score calculated by the CB scoring platform and returned to merchants. | [optional] -**pareq** | **str** | 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] -**pares_status** | **str** | 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] -**proof_xml** | **str** | 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] -**proxy_pan** | **str** | Encrypted version of the card number used in the payer authentication request message. | [optional] -**sdk_transaction_id** | **str** | SDK unique transaction identifier that is generated on each new transaction. | [optional] -**signed_pares_status_reason** | **str** | Provides additional information as to why the PAResStatus has a specific value. | [optional] -**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 | [optional] -**step_up_url** | **str** | The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration. | [optional] -**three_ds_server_transaction_id** | **str** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] -**ucaf_authentication_data** | **str** | 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] -**ucaf_collection_indicator** | **str** | 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] -**veres_enrolled** | **str** | 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] -**white_list_status_source** | **str** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional] -**xid** | **str** | 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] -**directory_server_transaction_id** | **str** | 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] -**acs_operator_id** | **str** | Directory Server assigned ACS identifier. | [optional] -**acs_reference_number** | **str** | Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval. | [optional] -**idci_decision** | **str** | Decision on the Risk Assessment from Mastercard. | [optional] -**idci_reason_code1** | **str** | ReasonCode from Mastercard | [optional] -**idci_reason_code2** | **str** | ReasonCode from Mastercard | [optional] -**idci_score** | **int** | Risk Assessment from Mastercard | [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/RiskV1DecisionsPost201ResponseErrorInformation.md b/docs/RiskV1DecisionsPost201ResponseErrorInformation.md deleted file mode 100644 index 20821dbe..00000000 --- a/docs/RiskV1DecisionsPost201ResponseErrorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# RiskV1DecisionsPost201ResponseErrorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | The reason of the status. Possible values: - `EXPIRED_CARD` - `SCORE_EXCEEDS_THRESHOLD` - `DECISION_PROFILE_REVIEW` - `DECISION_PROFILE_REJECT` - `CONSUMER_AUTHENTICATION_REQUIRED` - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_FAILED` - `DECISION_PROFILE_CHALLENGE` - `CUSTOMER_WATCHLIST_MATCH` - `ADDRESS_COUNTRY_WATCHLIST_MATCH` - `EMAIL_COUNTRY_WATCHLIST_MATCH` - `IP_COUNTRY_WATCHLIST_MATCH` | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1DecisionsPost201ResponseOrderInformation.md b/docs/RiskV1DecisionsPost201ResponseOrderInformation.md deleted file mode 100644 index 0199dab0..00000000 --- a/docs/RiskV1DecisionsPost201ResponseOrderInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# RiskV1DecisionsPost201ResponseOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_details** | [**RiskV1DecisionsPost201ResponseOrderInformationAmountDetails**](RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.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/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md b/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md deleted file mode 100644 index 9ce19e3b..00000000 --- a/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md +++ /dev/null @@ -1,10 +0,0 @@ -# RiskV1DecisionsPost201ResponseOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **str** | 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/RiskV1DecisionsPost201ResponsePaymentInformation.md b/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md deleted file mode 100644 index 4c32e1b6..00000000 --- a/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# RiskV1DecisionsPost201ResponsePaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bin_country** | **str** | 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] -**account_type** | **str** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. | [optional] -**issuer** | **str** | Name of the bank or entity that issued the card account. | [optional] -**scheme** | **str** | 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** | **str** | 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/RiskV1DecisionsPost400Response.md b/docs/RiskV1DecisionsPost400Response.md deleted file mode 100644 index d7295c1d..00000000 --- a/docs/RiskV1DecisionsPost400Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# RiskV1DecisionsPost400Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - `INVALID_REQUEST` - `DECLINED` | [optional] -**reason** | **str** | The reason of the status. Possible values: - `MISSING_FIELD` - `INVALID_DATA` - `INVALID_ACCOUNT` | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1DecisionsPost400Response1.md b/docs/RiskV1DecisionsPost400Response1.md deleted file mode 100644 index 0f46669b..00000000 --- a/docs/RiskV1DecisionsPost400Response1.md +++ /dev/null @@ -1,14 +0,0 @@ -# RiskV1DecisionsPost400Response1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] -**reason** | **str** | The reason of the status. Possible Values: - `MISSING_FIELD` - `INVALID_DATA` | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1ExportComplianceInquiriesPost201Response.md b/docs/RiskV1ExportComplianceInquiriesPost201Response.md deleted file mode 100644 index 194ebac0..00000000 --- a/docs/RiskV1ExportComplianceInquiriesPost201Response.md +++ /dev/null @@ -1,18 +0,0 @@ -# RiskV1ExportComplianceInquiriesPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**submit_time_local** | **str** | Time that the transaction was submitted in local time. Generated by Cybersource. | [optional] -**status** | **str** | The status for the call can be: - COMPLETED - INVALID_REQUEST - DECLINED | [optional] -**message** | **str** | The message describing the reason of the status. Value can be - The customer matched the Denied Parties List - The Export bill_country/ship_country match - Export email_country match - Export hostname_country/ip_country match | [optional] -**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] -**export_compliance_information** | [**PtsV2PaymentsPost201ResponseWatchlistScreeningInformation**](PtsV2PaymentsPost201ResponseWatchlistScreeningInformation.md) | | [optional] -**error_information** | [**RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation**](RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.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/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.md b/docs/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.md deleted file mode 100644 index 1f2231ef..00000000 --- a/docs/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | The reason of the status. Value can be - `CUSTOMER_WATCHLIST_MATCH` - `ADDRESS_COUNTRY_WATCHLIST_MATCH` - `EMAIL_COUNTRY_WATCHLIST_MATCH` - `IP_COUNTRY_WATCHLIST_MATCH` - `INVALID_MERCHANT_CONFIGURATION` | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1UpdatePost201Response.md b/docs/RiskV1UpdatePost201Response.md deleted file mode 100644 index 0fc289a8..00000000 --- a/docs/RiskV1UpdatePost201Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# RiskV1UpdatePost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] -**client_reference_informaton** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**status** | **str** | The status for risk update 201 calls. Possible values are: - INVALID_REQUEST - COMPLETED | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] - -[[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/Riskv1addressverificationsBuyerInformation.md b/docs/Riskv1addressverificationsBuyerInformation.md deleted file mode 100644 index beddceab..00000000 --- a/docs/Riskv1addressverificationsBuyerInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1addressverificationsBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_customer_id** | **str** | Optional customer's account ID, tracking number, reward number, or other unique number that you assign to the customer for the purpose that you choose | [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/Riskv1addressverificationsOrderInformation.md b/docs/Riskv1addressverificationsOrderInformation.md deleted file mode 100644 index dd5d536a..00000000 --- a/docs/Riskv1addressverificationsOrderInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Riskv1addressverificationsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bill_to** | [**Riskv1addressverificationsOrderInformationBillTo**](Riskv1addressverificationsOrderInformationBillTo.md) | | [optional] -**ship_to** | [**Riskv1addressverificationsOrderInformationShipTo**](Riskv1addressverificationsOrderInformationShipTo.md) | | [optional] -**line_items** | [**list[Riskv1addressverificationsOrderInformationLineItems]**](Riskv1addressverificationsOrderInformationLineItems.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/Riskv1addressverificationsOrderInformationBillTo.md b/docs/Riskv1addressverificationsOrderInformationBillTo.md deleted file mode 100644 index 6b025561..00000000 --- a/docs/Riskv1addressverificationsOrderInformationBillTo.md +++ /dev/null @@ -1,17 +0,0 @@ -# Riskv1addressverificationsOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | 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. | -**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] -**address3** | **str** | Additional address information (third line of the billing address) | [optional] -**address4** | **str** | Additional address information (fourth line of the billing address) | [optional] -**administrative_area** | **str** | 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] -**country** | **str** | 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. | -**locality** | **str** | 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. | -**postal_code** | **str** | 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/Riskv1addressverificationsOrderInformationLineItems.md b/docs/Riskv1addressverificationsOrderInformationLineItems.md deleted file mode 100644 index ea8a5b21..00000000 --- a/docs/Riskv1addressverificationsOrderInformationLineItems.md +++ /dev/null @@ -1,15 +0,0 @@ -# Riskv1addressverificationsOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | -**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] -**product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] -**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [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/Riskv1addressverificationsOrderInformationShipTo.md b/docs/Riskv1addressverificationsOrderInformationShipTo.md deleted file mode 100644 index 2c2f6136..00000000 --- a/docs/Riskv1addressverificationsOrderInformationShipTo.md +++ /dev/null @@ -1,17 +0,0 @@ -# Riskv1addressverificationsOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | -**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address3** | **str** | Third line of the shipping address. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address4** | **str** | Fourth line of the shipping address. | [optional] -**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | -**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [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/Riskv1authenticationresultsConsumerAuthenticationInformation.md b/docs/Riskv1authenticationresultsConsumerAuthenticationInformation.md deleted file mode 100644 index b6f0624f..00000000 --- a/docs/Riskv1authenticationresultsConsumerAuthenticationInformation.md +++ /dev/null @@ -1,17 +0,0 @@ -# Riskv1authenticationresultsConsumerAuthenticationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**authentication_transaction_id** | **str** | 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. | -**authentication_transaction_context** | **str** | Authentication transaction context is used as a unique identifier to link enroll and validate call. | [optional] -**otp_token** | **str** | OTP entered by the card holder. | [optional] -**response_access_token** | **str** | JWT returned by the 3D Secure provider when the authentication is complete. Required for Hybrid integration if you use the Cybersource-generated access token. Note: Max. length of this field is 2048 characters. | [optional] -**signed_pares_status_reason** | **str** | Provides additional information as to why the PAResStatus has a specific value. | [optional] -**signed_pares** | **str** | Payer authentication result (PARes) message returned by the card-issuing bank. If you need to show proof of enrollment checking, you may need to decrypt and parse the string for the information required by the payment card company. For more information, see \"Storing Payer Authentication Data,\" page 160. Important The value is in base64. You must remove all carriage returns and line feeds before adding the PARes to the request. | [optional] -**white_list_status** | **str** | Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder | [optional] -**credential_encrypted** | **str** | A flag to indicate if the passed credential has been encrypted by the Merchant. | [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/Riskv1authenticationresultsDeviceInformation.md b/docs/Riskv1authenticationresultsDeviceInformation.md deleted file mode 100644 index ecd34e74..00000000 --- a/docs/Riskv1authenticationresultsDeviceInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1authenticationresultsDeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** 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/Riskv1authenticationresultsOrderInformation.md b/docs/Riskv1authenticationresultsOrderInformation.md deleted file mode 100644 index 11468d96..00000000 --- a/docs/Riskv1authenticationresultsOrderInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1authenticationresultsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_details** | [**Riskv1authenticationresultsOrderInformationAmountDetails**](Riskv1authenticationresultsOrderInformationAmountDetails.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/Riskv1authenticationresultsOrderInformationAmountDetails.md b/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md deleted file mode 100644 index eeafb88a..00000000 --- a/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1authenticationresultsOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **str** | 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] -**total_amount** | **str** | 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 / Pay By Link Required for creating a new invoice or payment link. #### 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/Riskv1authenticationresultsPaymentInformation.md b/docs/Riskv1authenticationresultsPaymentInformation.md deleted file mode 100644 index 7d22260d..00000000 --- a/docs/Riskv1authenticationresultsPaymentInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationresultsPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**Riskv1authenticationresultsPaymentInformationCard**](Riskv1authenticationresultsPaymentInformationCard.md) | | [optional] -**tokenized_card** | [**Riskv1authenticationresultsPaymentInformationTokenizedCard**](Riskv1authenticationresultsPaymentInformationTokenizedCard.md) | | [optional] -**fluid_data** | [**Riskv1authenticationresultsPaymentInformationFluidData**](Riskv1authenticationresultsPaymentInformationFluidData.md) | | [optional] -**customer** | [**Riskv1authenticationsPaymentInformationCustomer**](Riskv1authenticationsPaymentInformationCustomer.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/Riskv1authenticationresultsPaymentInformationCard.md b/docs/Riskv1authenticationresultsPaymentInformationCard.md deleted file mode 100644 index 0a039060..00000000 --- a/docs/Riskv1authenticationresultsPaymentInformationCard.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationresultsPaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] -**expiration_year** | **str** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] -**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [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/Riskv1authenticationresultsPaymentInformationFluidData.md b/docs/Riskv1authenticationresultsPaymentInformationFluidData.md deleted file mode 100644 index d4250982..00000000 --- a/docs/Riskv1authenticationresultsPaymentInformationFluidData.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationresultsPaymentInformationFluidData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | **str** | Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution used by the merchant. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits that use a Cybersource suppored Point-to-Point encryption method. Card Present processing This field represents the encrypted payment data generated by the payment terminal/device. | [optional] -**key_serial_number** | **str** | The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) | [optional] -**descriptor** | **str** | The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is `Ymx1ZWZpbg==`. paymentInformation.fluidData.encoding must be `Base64`. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is `Base64`, the value is: `RklEPUVNVi5QQVlNRU5ULkFQSQ==` If paymentInformation.fluidData.encoding is `HEX`, the value is: `4649443D454D562E5041594D454E542E41504` | [optional] -**encoding** | **str** | Encoding method used to encrypt the payment data. Valid values: `Base64`, `HEX` If no value is provided, `Base64` is taken as the default value. And the `Base64` descriptor is used for paymentInformation.fluidData.encoding | [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/Riskv1authenticationresultsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md deleted file mode 100644 index c784fc1c..00000000 --- a/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md +++ /dev/null @@ -1,14 +0,0 @@ -# Riskv1authenticationresultsPaymentInformationTokenizedCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | [optional] -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] -**number** | **str** | Customer's payment network token value. | [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/Riskv1authenticationsBuyerInformation.md b/docs/Riskv1authenticationsBuyerInformation.md deleted file mode 100644 index f7be07fe..00000000 --- a/docs/Riskv1authenticationsBuyerInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationsBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_customer_id** | **str** | 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] -**personal_identification** | [**list[Ptsv2paymentsBuyerInformationPersonalIdentification]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | This array contains detailed information about the buyer's form of persoanl identification. | [optional] -**mobile_phone** | **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. | -**work_phone** | **int** | Cardholder's work phone number. | [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/Riskv1authenticationsDeviceInformation.md b/docs/Riskv1authenticationsDeviceInformation.md deleted file mode 100644 index b34d6f58..00000000 --- a/docs/Riskv1authenticationsDeviceInformation.md +++ /dev/null @@ -1,21 +0,0 @@ -# Riskv1authenticationsDeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] -**raw_data** | [**list[Ptsv2paymentsDeviceInformationRawData]**](Ptsv2paymentsDeviceInformationRawData.md) | | [optional] -**http_accept_browser_value** | **str** | Value of the Accept header sent by the customer's web browser. **Note** If the customer's browser provides a value, you must include it in your request. | [optional] -**http_accept_content** | **str** | The exact content of the HTTP accept header. | -**http_browser_language** | **str** | Value represents the browser language as defined in IETF BCP47. Example:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details. | -**http_browser_java_enabled** | **bool** | A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False | -**http_browser_java_script_enabled** | **bool** | A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. **Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser. | [optional] -**http_browser_color_depth** | **str** | Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details | -**http_browser_screen_height** | **str** | Total height of the Cardholder's scree in pixels, example: 864. | -**http_browser_screen_width** | **str** | Total width of the cardholder's screen in pixels. Example: 1536. | -**http_browser_time_difference** | **str** | Time difference between UTC time and the cardholder browser local time, in minutes, Example:300 | -**user_agent_browser_value** | **str** | Value of the User-Agent header sent by the customer's web browser. Note If the customer's browser provides a value, you must include it in your request. | - -[[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/Riskv1authenticationsOrderInformation.md b/docs/Riskv1authenticationsOrderInformation.md deleted file mode 100644 index 2d0f45d3..00000000 --- a/docs/Riskv1authenticationsOrderInformation.md +++ /dev/null @@ -1,17 +0,0 @@ -# Riskv1authenticationsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_details** | [**Riskv1authenticationsOrderInformationAmountDetails**](Riskv1authenticationsOrderInformationAmountDetails.md) | | [optional] -**pre_order** | **str** | Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability | [optional] -**pre_order_date** | **str** | Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD | [optional] -**reordered** | **bool** | Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered | [optional] -**ship_to** | [**Riskv1decisionsOrderInformationShipTo**](Riskv1decisionsOrderInformationShipTo.md) | | [optional] -**line_items** | [**list[Riskv1authenticationsOrderInformationLineItems]**](Riskv1authenticationsOrderInformationLineItems.md) | This array contains detailed information about individual products in the order. | [optional] -**bill_to** | [**Riskv1authenticationsOrderInformationBillTo**](Riskv1authenticationsOrderInformationBillTo.md) | | [optional] -**total_offers_count** | **str** | Total number of articles/items in the order as a numeric decimal count. Possible values: 00 - 99 | [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/Riskv1authenticationsOrderInformationAmountDetails.md b/docs/Riskv1authenticationsOrderInformationAmountDetails.md deleted file mode 100644 index 1e1033d9..00000000 --- a/docs/Riskv1authenticationsOrderInformationAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1authenticationsOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **str** | 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. | -**total_amount** | **str** | 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 / Pay By Link Required for creating a new invoice or payment link. #### 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/Riskv1authenticationsOrderInformationBillTo.md b/docs/Riskv1authenticationsOrderInformationBillTo.md deleted file mode 100644 index 5b153e9e..00000000 --- a/docs/Riskv1authenticationsOrderInformationBillTo.md +++ /dev/null @@ -1,20 +0,0 @@ -# Riskv1authenticationsOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | 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. | -**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] -**address3** | **str** | Additional address information (third line of the billing address) | [optional] -**administrative_area** | **str** | 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. | -**country** | **str** | 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. | -**locality** | **str** | 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] -**first_name** | **str** | 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. | -**last_name** | **str** | 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. | -**phone_number** | **str** | 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** | **str** | 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. | -**postal_code** | **str** | 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/Riskv1authenticationsOrderInformationLineItems.md b/docs/Riskv1authenticationsOrderInformationLineItems.md deleted file mode 100644 index cfc377dd..00000000 --- a/docs/Riskv1authenticationsOrderInformationLineItems.md +++ /dev/null @@ -1,29 +0,0 @@ -# Riskv1authenticationsOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | -**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] -**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] -**product_description** | **str** | Brief description of item. | [optional] -**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**passenger** | [**Ptsv2paymentsOrderInformationPassenger**](Ptsv2paymentsOrderInformationPassenger.md) | | [optional] -**shipping_destination_types** | **str** | Destination to where the item will be shipped. Example: Commercial, Residential, Store | [optional] -**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] -**shipping_address1** | **str** | Address where item will be shipped | [optional] -**shipping_address2** | **str** | Address where item will be shipped | [optional] -**shipping_city** | **str** | City where item will be shipped | [optional] -**shipping_country_code** | **str** | Country where item will be shipped | [optional] -**shipping_first_name** | **str** | Customer's first name | [optional] -**shipping_last_name** | **str** | Customer's last name | [optional] -**shipping_middle_name** | **str** | Customer's middle name | [optional] -**shipping_phone** | **int** | Phone number where item will be shipped | [optional] -**shipping_postal_code** | **int** | Postal code where item will be shipped | [optional] -**shipping_state** | **str** | State where item will be shipped | [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/Riskv1authenticationsPaymentInformation.md b/docs/Riskv1authenticationsPaymentInformation.md deleted file mode 100644 index dad1e13b..00000000 --- a/docs/Riskv1authenticationsPaymentInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationsPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**Riskv1authenticationsetupsPaymentInformationCard**](Riskv1authenticationsetupsPaymentInformationCard.md) | | [optional] -**tokenized_card** | [**Riskv1authenticationsPaymentInformationTokenizedCard**](Riskv1authenticationsPaymentInformationTokenizedCard.md) | | [optional] -**fluid_data** | [**Riskv1authenticationsetupsPaymentInformationFluidData**](Riskv1authenticationsetupsPaymentInformationFluidData.md) | | [optional] -**customer** | [**Riskv1authenticationsPaymentInformationCustomer**](Riskv1authenticationsPaymentInformationCustomer.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/Riskv1authenticationsPaymentInformationCustomer.md b/docs/Riskv1authenticationsPaymentInformationCustomer.md deleted file mode 100644 index ac2fe58e..00000000 --- a/docs/Riskv1authenticationsPaymentInformationCustomer.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1authenticationsPaymentInformationCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_id** | **str** | Unique identifier for the legacy Secure Storage 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. | -**id** | **str** | 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/Riskv1authenticationsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md deleted file mode 100644 index fa7fc2ab..00000000 --- a/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md +++ /dev/null @@ -1,16 +0,0 @@ -# Riskv1authenticationsPaymentInformationTokenizedCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | -**cryptogram** | **str** | This field contains token information. | -**security_code** | **str** | Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. | -**number** | **str** | Customer's payment network token value. | - -[[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/Riskv1authenticationsRiskInformation.md b/docs/Riskv1authenticationsRiskInformation.md deleted file mode 100644 index 4db45839..00000000 --- a/docs/Riskv1authenticationsRiskInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1authenticationsRiskInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**buyer_history** | [**Ptsv2paymentsRiskInformationBuyerHistory**](Ptsv2paymentsRiskInformationBuyerHistory.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/Riskv1authenticationsTravelInformation.md b/docs/Riskv1authenticationsTravelInformation.md deleted file mode 100644 index 82cb47fb..00000000 --- a/docs/Riskv1authenticationsTravelInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Riskv1authenticationsTravelInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**legs** | [**list[Riskv1decisionsTravelInformationLegs]**](Riskv1decisionsTravelInformationLegs.md) | | [optional] -**number_of_passengers** | **int** | Number of passengers for whom the ticket was issued. If you do not include this field in your request, CyberSource uses a default value of 1. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] -**passengers** | [**list[Riskv1decisionsTravelInformationPassengers]**](Riskv1decisionsTravelInformationPassengers.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/Riskv1authenticationsetupsClientReferenceInformation.md b/docs/Riskv1authenticationsetupsClientReferenceInformation.md deleted file mode 100644 index 2d98c603..00000000 --- a/docs/Riskv1authenticationsetupsClientReferenceInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationsetupsClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | 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] -**paused_request_id** | **str** | 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** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**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/Riskv1authenticationsetupsPaymentInformation.md b/docs/Riskv1authenticationsetupsPaymentInformation.md deleted file mode 100644 index 5f9e58e8..00000000 --- a/docs/Riskv1authenticationsetupsPaymentInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationsetupsPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**Riskv1authenticationsetupsPaymentInformationCard**](Riskv1authenticationsetupsPaymentInformationCard.md) | | [optional] -**tokenized_card** | [**Riskv1authenticationsetupsPaymentInformationTokenizedCard**](Riskv1authenticationsetupsPaymentInformationTokenizedCard.md) | | [optional] -**fluid_data** | [**Riskv1authenticationsetupsPaymentInformationFluidData**](Riskv1authenticationsetupsPaymentInformationFluidData.md) | | [optional] -**customer** | [**Riskv1authenticationsetupsPaymentInformationCustomer**](Riskv1authenticationsetupsPaymentInformationCustomer.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/Riskv1authenticationsetupsPaymentInformationCard.md b/docs/Riskv1authenticationsetupsPaymentInformationCard.md deleted file mode 100644 index 2e803e08..00000000 --- a/docs/Riskv1authenticationsetupsPaymentInformationCard.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationsetupsPaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | -**expiration_year** | **str** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | -**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | - -[[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/Riskv1authenticationsetupsPaymentInformationCustomer.md b/docs/Riskv1authenticationsetupsPaymentInformationCustomer.md deleted file mode 100644 index e87c1e1e..00000000 --- a/docs/Riskv1authenticationsetupsPaymentInformationCustomer.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1authenticationsetupsPaymentInformationCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_id** | **str** | Unique identifier for the legacy Secure Storage 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. | - -[[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/Riskv1authenticationsetupsPaymentInformationFluidData.md b/docs/Riskv1authenticationsetupsPaymentInformationFluidData.md deleted file mode 100644 index 46ec1367..00000000 --- a/docs/Riskv1authenticationsetupsPaymentInformationFluidData.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1authenticationsetupsPaymentInformationFluidData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | **str** | Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution used by the merchant. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits that use a Cybersource suppored Point-to-Point encryption method. Card Present processing This field represents the encrypted payment data generated by the payment terminal/device. | -**key_serial_number** | **str** | The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) | [optional] -**descriptor** | **str** | The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is `Ymx1ZWZpbg==`. paymentInformation.fluidData.encoding must be `Base64`. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is `Base64`, the value is: `RklEPUVNVi5QQVlNRU5ULkFQSQ==` If paymentInformation.fluidData.encoding is `HEX`, the value is: `4649443D454D562E5041594D454E542E41504` | [optional] -**encoding** | **str** | Encoding method used to encrypt the payment data. Valid values: `Base64`, `HEX` If no value is provided, `Base64` is taken as the default value. And the `Base64` descriptor is used for paymentInformation.fluidData.encoding | [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/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md deleted file mode 100644 index 8f3b7ae6..00000000 --- a/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md +++ /dev/null @@ -1,14 +0,0 @@ -# Riskv1authenticationsetupsPaymentInformationTokenizedCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | -**number** | **str** | Customer's payment network token value. | - -[[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/Riskv1authenticationsetupsProcessingInformation.md b/docs/Riskv1authenticationsetupsProcessingInformation.md deleted file mode 100644 index 20c84a1a..00000000 --- a/docs/Riskv1authenticationsetupsProcessingInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1authenticationsetupsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] -**visa_checkout_id** | **str** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** 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/Riskv1authenticationsetupsTokenInformation.md b/docs/Riskv1authenticationsetupsTokenInformation.md deleted file mode 100644 index 9fbd71bb..00000000 --- a/docs/Riskv1authenticationsetupsTokenInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1authenticationsetupsTokenInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transient_token** | **str** | A temporary ID that represents the customer's payment data (which is securely stored in Visa Data Centers). Flex Microform generates this ID and sets it to expire within 15 minutes from when the ID is generated or until the first payment authorization is carried out (whichever occurs first). Valid value for the ID is a 64-character, alphanumeric string. Example: 1D08M4YB968R1F7YVL4TBBKYVNRIR02VZFH9CBYSQIJJXORPI1NK5C98D7F6EB53 | [optional] -**jti** | **str** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [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/Riskv1decisionsAcquirerInformation.md b/docs/Riskv1decisionsAcquirerInformation.md deleted file mode 100644 index 1f792aa0..00000000 --- a/docs/Riskv1decisionsAcquirerInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1decisionsAcquirerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**acquirer_bin** | **str** | Acquirer bank ID number that corresponds to a certificate that Cybersource already has.This ID has this format. 4XXXXX for Visa and 5XXXXX for Mastercard. | [optional] -**country** | **str** | Issuers need to be aware of the Acquirer's Country Code when the Acquirer country differs from the Merchant country and the Acquirer is in the EEA (European Economic Area). | [optional] -**password** | **str** | Registered password for the Visa directory server. | [optional] -**merchant_id** | **str** | Username for the visa directory server that is created when your acquirer sets up your account. This ID might be the same as your merchant ID. the username can be 15 or 23 characters. | [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/Riskv1decisionsBuyerInformation.md b/docs/Riskv1decisionsBuyerInformation.md deleted file mode 100644 index 305597d0..00000000 --- a/docs/Riskv1decisionsBuyerInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# Riskv1decisionsBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_customer_id** | **str** | 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** | **str** | Specifies the customer account user name. | [optional] -**hashed_password** | **str** | The merchant's password that CyberSource hashes and stores as a hashed password. | [optional] -**date_of_birth** | **str** | 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] -**personal_identification** | [**list[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/Riskv1decisionsClientReferenceInformation.md b/docs/Riskv1decisionsClientReferenceInformation.md deleted file mode 100644 index cbf1ad29..00000000 --- a/docs/Riskv1decisionsClientReferenceInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1decisionsClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | 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. | -**paused_request_id** | **str** | 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** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**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/Riskv1decisionsClientReferenceInformationPartner.md b/docs/Riskv1decisionsClientReferenceInformationPartner.md deleted file mode 100644 index d5cf9265..00000000 --- a/docs/Riskv1decisionsClientReferenceInformationPartner.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsClientReferenceInformationPartner - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**developer_id** | **str** | Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. | [optional] -**solution_id** | **str** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [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/Riskv1decisionsConsumerAuthenticationInformation.md b/docs/Riskv1decisionsConsumerAuthenticationInformation.md deleted file mode 100644 index 33496496..00000000 --- a/docs/Riskv1decisionsConsumerAuthenticationInformation.md +++ /dev/null @@ -1,49 +0,0 @@ -# Riskv1decisionsConsumerAuthenticationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**strong_authentication** | [**Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication**](Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md) | | [optional] -**acs_window_size** | **str** | An override field that a merchant can pass in to set the challenge window size to display to the end cardholder. The ACS (Active Control Server) will reply with content that is formatted appropriately to this window size to allow for the best user experience. The sizes are width x height in pixels of the window displayed in the cardholder browser window. 01 - 250x400 02 - 390x400 03 - 500x600 04 - 600x400 05 - Full page | [optional] -**alternate_authentication_data** | **str** | Data that documents and supports a specific authentication process. | [optional] -**alternate_authentication_date** | **str** | Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM | [optional] -**alternate_authentication_method** | **str** | Mechanism used by the cardholder to authenticate to the 3D Secure requestor. Possible values: - `01`: No authentication occurred - `02`: Login using merchant system credentials - `03`: Login using Federated ID - `04`: Login using issuer credentials - `05`: Login using third-party authenticator - `06`: Login using FIDO Authenticator | [optional] -**authentication_date** | **str** | 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] -**authentication_transaction_id** | **str** | 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] -**transaction_flow_indicator** | **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] -**challenge_code** | **str** | 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] -**challenge_status** | **str** | 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] -**customer_card_alias** | **str** | 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] -**decoupled_authentication_indicator** | **str** | 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] -**decoupled_authentication_max_time** | **str** | Indicates the maximum amount of time that the 3DS Requestor will wait for an ACS (Active control server) to provide the results of a Decoupled Authentication transaction (in minutes). Possible Values: Numeric values between 1 and 10080 accepted. | [optional] -**default_card** | **bool** | Indicates that the card being used is the one designated as the primary payment card for purchase. Recommended for Discover ProtectBuy. | [optional] -**device_channel** | **str** | Determines the channel that the transaction came through. Possible Values: SDK/Browser/3RI. 3RI - 3DS request initiated. | -**installment_total_count** | **int** | An integer value greater than 1 indicating the max number of permitted authorizations for installment payments. **Note** This is required if the merchant and cardholder have agreed to installment payments. | [optional] -**merchant_fraud_rate** | **str** | Calculated by merchants as per PSD2** RTS** (EEA** card fraud divided by all EEA card volumes). Possible Values: 1 = Represents fraud rate <=1 2 = Represents fraud rate >1 and <=6 3 = Represents fraud rate >6 and <=13 4 = Represents fraud rate >13 and <=25 5 = Represents fraud rate >25 EEA** = European Economic Area RTS** = Regulatory Technical Standards PSD2** = Payment Services Directive | [optional] -**marketing_opt_in** | **bool** | Indicates whether the customer has opted in for marketing offers. Recommended for Discover ProtectBuy. | [optional] -**marketing_source** | **str** | Indicates origin of the marketing offer. Recommended for Discover ProtectBuy. | [optional] -**mcc** | **str** | Merchant category code. **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. | [optional] -**merchant_score** | **int** | Risk Score provided by merchants. This is specific for CB transactions. | [optional] -**message_category** | **str** | Category of the message for a specific use case. Possible values: - `01`: PA- payment authentication - `02`: NPA- non-payment authentication - `03-79`: Reserved for EMVCo future use (values invalid until defined by EMVCo) - `80-99`: Reserved for DS use | [optional] -**npa_code** | **str** | Non-Payer Authentication Indicator. Possible values: - `01`: Add card - `02`: Maintain card information - `03`: Cardholder verification for EMV token - `04-80` Reserved for EMVCo - `80-90` Reserved DS | [optional] -**override_payment_method** | **str** | Specifies the Brazilian payment account type used for the transaction. This field overrides other payment types that might be specified in the request. Use one of the following values for this field: - `NA`: Not applicable. Do not override other payment types that are specified in the request. - `CR`: Credit card. - `DB`: Debit card. - `VSAVR`: Visa Vale Refeicao - `VSAVA`: Visa Vale Alimentacao **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. | [optional] -**override_country_code** | **str** | Two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).. | [optional] -**prior_authentication_data** | **str** | This field carry data that the ACS can use to verify the authentication process. | [optional] -**prior_authentication_method** | **str** | Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. 01 - Frictionless authentication occurred by ACS 02 - Cardholder challenge occurred by ACS 03 - AVS verified 04 - Other issuer methods 05-79 - Reserved for EMVCo future use (values invalid until defined by EMVCo) 80-99 - Reserved for DS use | [optional] -**prior_authentication_reference_id** | **str** | This data element contains a ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder | [optional] -**prior_authentication_time** | **str** | Date and time in UTC of the prior cardholder authentication. Format – YYYYMMDDHHMM | [optional] -**product_code** | **str** | Specifies the product code, which designates the type of transaction. Specify one of the following values for this field: - AIR: Airline purchase Important Required for American Express SafeKey (U.S.). - `ACC`: Accommodation Rental - `ACF`: Account funding - `CHA`: Check acceptance - `DIG`: Digital Goods - `DSP`: Cash Dispensing - `GAS`: Fuel - `GEN`: General Retail - `LUX`: Luxury Retail - `PAL`: Prepaid activation and load - `PHY`: Goods or services purchase - `QCT`: Quasi-cash transaction - `REN`: Car Rental - `RES`: Restaurant - `SVC`: Services - `TBD`: Other - `TRA`: Travel **Important** Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. | [optional] -**return_url** | **str** | The URL of the merchant's return page. CyberSource adds this return URL to the step-up JWT and returns it in the response of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL. Once the bank session completes, the merchant receives a POST to their URL. This response contains the completed bank session's transactionId. The merchant's return page should capture the transaction ID and send it in the Payer Authentication validation call. | [optional] -**requestor_id** | **str** | Cardinal's directory server assigned 3DS Requestor ID value | [optional] -**requestor_initiated_authentication_indicator** | **str** | Indicates the type of 3RI request. Possible Values: 01 - Recurring transaction 02 - Installment transaction 03 - Add card 04 - Maintain card 05 - Account verification 06 - Split/delayed shipment 07 - Top-up 08 - Mail Order 09 - Telephone Order 10 - Whitelist status check 11 - Other payment | [optional] -**requestor_name** | **str** | Cardinal's directory server assigned 3DS Requestor Name value | [optional] -**reference_id** | **str** | Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration. | [optional] -**sdk_max_timeout** | **str** | This field indicates the maximum amount of time for all 3DS 2.0 messages to be communicated between all components (in minutes). Possible Values: Greater than or equal to 05 (05 is the minimum timeout to set) Cardinal Default is set to 15 NOTE: This field is a required 3DS 2.0 field and Cardinal sends in a default of 15 if nothing is passed | [optional] -**secure_corporate_payment_indicator** | **str** | Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies. Possible Values : 0/1 | [optional] -**transaction_mode** | **str** | Transaction mode identifier. Identifies the channel from which the transaction originates. Possible values: - `M`: MOTO (Mail Order Telephone Order) - `R`: Retail - `S`: eCommerce - `P`: Mobile Device - `T`: Tablet | [optional] -**white_list_status** | **str** | Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder | [optional] -**score_request** | **int** | Risk Assessment from Mastercard. This is to be sent by merchant if they would like to request a score | [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/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md b/docs/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md deleted file mode 100644 index 2046768d..00000000 --- a/docs/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**authentication_indicator** | **str** | Indicates the type of Authentication request 01 - Payment transaction 02 - Recurring transaction 03 - Installment transaction 04 - Add card 05 - Maintain card 06 - Cardholder verification as part of EMV token ID and V | [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/Riskv1decisionsDeviceInformation.md b/docs/Riskv1decisionsDeviceInformation.md deleted file mode 100644 index 09ab6a40..00000000 --- a/docs/Riskv1decisionsDeviceInformation.md +++ /dev/null @@ -1,26 +0,0 @@ -# Riskv1decisionsDeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cookies_accepted** | **str** | Whether the customer's browser accepts cookies. This field can contain one of the following values: - `yes`: The customer's browser accepts cookies. - `no`: The customer's browser does not accept cookies. | [optional] -**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] -**host_name** | **str** | DNS resolved hostname from `ipAddress`. | [optional] -**fingerprint_session_id** | **str** | Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID. The session ID must be unique for each page load, regardless of an individual's web session ID. If a user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. You may use a web session ID, but it is preferable to use an application GUID (Globally Unique Identifier). This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page. | [optional] -**http_browser_email** | **str** | Email address set in the customer's browser, which may differ from customer email. | [optional] -**user_agent** | **str** | Customer's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser. | [optional] -**raw_data** | [**list[Ptsv2paymentsDeviceInformationRawData]**](Ptsv2paymentsDeviceInformationRawData.md) | | [optional] -**http_accept_browser_value** | **str** | Value of the Accept header sent by the customer's web browser. **Note** If the customer's browser provides a value, you must include it in your request. | [optional] -**http_accept_content** | **str** | The exact content of the HTTP accept header. | [optional] -**http_browser_language** | **str** | Value represents the browser language as defined in IETF BCP47. Example:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details. | [optional] -**http_browser_java_enabled** | **bool** | A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False | [optional] -**http_browser_java_script_enabled** | **bool** | A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. **Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser. | [optional] -**http_browser_color_depth** | **str** | Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details | [optional] -**http_browser_screen_height** | **str** | Total height of the Cardholder's scree in pixels, example: 864. | [optional] -**http_browser_screen_width** | **str** | Total width of the cardholder's screen in pixels. Example: 1536. | [optional] -**http_browser_time_difference** | **str** | Time difference between UTC time and the cardholder browser local time, in minutes, Example:300 | [optional] -**user_agent_browser_value** | **str** | Value of the User-Agent header sent by the customer's web browser. Note If the customer's browser provides a value, you must include it in your request. | [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/Riskv1decisionsMerchantDefinedInformation.md b/docs/Riskv1decisionsMerchantDefinedInformation.md deleted file mode 100644 index 076a652e..00000000 --- a/docs/Riskv1decisionsMerchantDefinedInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsMerchantDefinedInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **str** | Fields that you can use to store information. The value appears in the Case Management Details window in the Business Center. The first four fields are the same fields that are used by the Secure Data services. See request code examples. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. | [optional] -**value** | **str** | String value for the key | [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/Riskv1decisionsMerchantInformation.md b/docs/Riskv1decisionsMerchantInformation.md deleted file mode 100644 index 9878f9cb..00000000 --- a/docs/Riskv1decisionsMerchantInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_descriptor** | [**Riskv1decisionsMerchantInformationMerchantDescriptor**](Riskv1decisionsMerchantInformationMerchantDescriptor.md) | | [optional] -**merchant_name** | **str** | Your company's name as you want it to appear to the customer in the issuing bank's authentication form. This value overrides the value specified by your merchant bank. | [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/Riskv1decisionsMerchantInformationMerchantDescriptor.md b/docs/Riskv1decisionsMerchantInformationMerchantDescriptor.md deleted file mode 100644 index 9a4d79c8..00000000 --- a/docs/Riskv1decisionsMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. **Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. **Important** This value must consist of English characters. Required for captures and credits. | [optional] -**url** | **str** | Address of company's website provided by merchant | [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/Riskv1decisionsOrderInformation.md b/docs/Riskv1decisionsOrderInformation.md deleted file mode 100644 index dbe2996c..00000000 --- a/docs/Riskv1decisionsOrderInformation.md +++ /dev/null @@ -1,20 +0,0 @@ -# Riskv1decisionsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_details** | [**Riskv1decisionsOrderInformationAmountDetails**](Riskv1decisionsOrderInformationAmountDetails.md) | | [optional] -**pre_order** | **str** | Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability | [optional] -**pre_order_date** | **str** | Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD | [optional] -**cutoff_date_time** | **str** | Starting date and time for an event or a journey that is independent of which transportation mechanism, in UTC. The cutoffDateTime will supersede travelInformation.departureTime if both are supplied in the request. 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] -**reordered** | **bool** | Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered | [optional] -**shipping_details** | [**Riskv1decisionsOrderInformationShippingDetails**](Riskv1decisionsOrderInformationShippingDetails.md) | | [optional] -**ship_to** | [**Riskv1decisionsOrderInformationShipTo**](Riskv1decisionsOrderInformationShipTo.md) | | [optional] -**returns_accepted** | **bool** | Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - true: Returns are accepted for this order. - false: Returns are not accepted for this order. | [optional] -**line_items** | [**list[Riskv1decisionsOrderInformationLineItems]**](Riskv1decisionsOrderInformationLineItems.md) | This array contains detailed information about individual products in the order. | [optional] -**bill_to** | [**Riskv1decisionsOrderInformationBillTo**](Riskv1decisionsOrderInformationBillTo.md) | | [optional] -**total_offers_count** | **str** | Total number of articles/items in the order as a numeric decimal count. Possible values: 00 - 99 | [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/Riskv1decisionsOrderInformationAmountDetails.md b/docs/Riskv1decisionsOrderInformationAmountDetails.md deleted file mode 100644 index 5e24ad10..00000000 --- a/docs/Riskv1decisionsOrderInformationAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **str** | 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. | -**total_amount** | **str** | 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. 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. 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 [REST API Fields Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) #### DCC for First Data Not used. For details, see [REST API Field Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) | [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/Riskv1decisionsOrderInformationBillTo.md b/docs/Riskv1decisionsOrderInformationBillTo.md deleted file mode 100644 index 22315330..00000000 --- a/docs/Riskv1decisionsOrderInformationBillTo.md +++ /dev/null @@ -1,19 +0,0 @@ -# Riskv1decisionsOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | 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] -**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] -**administrative_area** | **str** | 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] -**country** | **str** | 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] -**locality** | **str** | 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] -**first_name** | **str** | 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] -**last_name** | **str** | 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] -**phone_number** | **str** | 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** | **str** | 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] -**postal_code** | **str** | 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/Riskv1decisionsOrderInformationLineItems.md b/docs/Riskv1decisionsOrderInformationLineItems.md deleted file mode 100644 index 5aacf8fa..00000000 --- a/docs/Riskv1decisionsOrderInformationLineItems.md +++ /dev/null @@ -1,25 +0,0 @@ -# Riskv1decisionsOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] -**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] -**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] -**product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] -**product_description** | **str** | Brief description of item. | [optional] -**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] -**gift** | **bool** | This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different. | [optional] -**distributor_product_sku** | **str** | Product's identifier code. This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer) in the list of API fields with which you can create custom rules. | [optional] -**passenger** | [**Ptsv2paymentsOrderInformationPassenger**](Ptsv2paymentsOrderInformationPassenger.md) | | [optional] -**shipping_destination_types** | **str** | Destination to where the item will be shipped. Example: Commercial, Residential, Store | [optional] -**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] -**allowed_export_countries** | **list[str]** | | [optional] -**restricted_export_countries** | **list[str]** | | [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/Riskv1decisionsOrderInformationShipTo.md b/docs/Riskv1decisionsOrderInformationShipTo.md deleted file mode 100644 index 0d5ae7a6..00000000 --- a/docs/Riskv1decisionsOrderInformationShipTo.md +++ /dev/null @@ -1,23 +0,0 @@ -# Riskv1decisionsOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address3** | **str** | Third line of the shipping address. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**destination_types** | **str** | Shipping destination of item. Example: Commercial, Residential, Store | [optional] -**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**middle_name** | **str** | Middle name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**phone_number** | **str** | Phone number associated with the shipping address. | [optional] -**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**destination_code** | **int** | Indicates destination chosen for the transaction. Possible values: - 01- Ship to cardholder billing address - 02- Ship to another verified address on file with merchant - 03- Ship to address that is different than billing address - 04- Ship to store (store address should be populated on request) - 05- Digital goods - 06- Travel and event tickets, not shipped - 07- Other | [optional] -**method** | **str** | Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription Required for American Express SafeKey (U.S.). | [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/Riskv1decisionsOrderInformationShippingDetails.md b/docs/Riskv1decisionsOrderInformationShippingDetails.md deleted file mode 100644 index 2bdd73df..00000000 --- a/docs/Riskv1decisionsOrderInformationShippingDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsOrderInformationShippingDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**gift_wrap** | **bool** | Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping. | [optional] -**shipping_method** | **str** | Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription | [optional] - -[[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/Riskv1decisionsPaymentInformation.md b/docs/Riskv1decisionsPaymentInformation.md deleted file mode 100644 index 9c5c9c6f..00000000 --- a/docs/Riskv1decisionsPaymentInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# Riskv1decisionsPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**Riskv1decisionsPaymentInformationCard**](Riskv1decisionsPaymentInformationCard.md) | | [optional] -**tokenized_card** | [**Riskv1decisionsPaymentInformationTokenizedCard**](Riskv1decisionsPaymentInformationTokenizedCard.md) | | [optional] -**customer** | [**Ptsv2paymentsPaymentInformationCustomer**](Ptsv2paymentsPaymentInformationCustomer.md) | | [optional] -**bank** | [**Ptsv2paymentsPaymentInformationBank**](Ptsv2paymentsPaymentInformationBank.md) | | [optional] -**method** | **str** | Method of payment used for the order. This field can contain one of the following values: - `consumer` (default): Customer credit card - `corporate`: Corporate credit card - `debit`: Debit card, such as a Maestro (UK Domestic) card - `cod`: Collect on delivery - `check`: Electronic check - `p2p`: Person-to-person payment - `private1`: Private label credit card - `other`: Other payment method | [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/Riskv1decisionsPaymentInformationCard.md b/docs/Riskv1decisionsPaymentInformationCard.md deleted file mode 100644 index efe8850b..00000000 --- a/docs/Riskv1decisionsPaymentInformationCard.md +++ /dev/null @@ -1,14 +0,0 @@ -# Riskv1decisionsPaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**bin** | **str** | description: The BIN is the first six digits of the card's Primary Account Number (PAN). | [optional] -**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] -**expiration_year** | **str** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [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/Riskv1decisionsPaymentInformationTokenizedCard.md b/docs/Riskv1decisionsPaymentInformationTokenizedCard.md deleted file mode 100644 index 15d2fec5..00000000 --- a/docs/Riskv1decisionsPaymentInformationTokenizedCard.md +++ /dev/null @@ -1,14 +0,0 @@ -# Riskv1decisionsPaymentInformationTokenizedCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | [optional] -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**number** | **str** | Customer's payment network token value. | [optional] -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [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/Riskv1decisionsProcessingInformation.md b/docs/Riskv1decisionsProcessingInformation.md deleted file mode 100644 index 0aafc6f2..00000000 --- a/docs/Riskv1decisionsProcessingInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1decisionsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**action_list** | **list[str]** | - Use `CONSUMER_AUTHENTICATION` to use Payer Authentication along with Decision Manager. For any other value, only Decision Manager will run. - Use `WATCHLIST_SCREENING` when you want to call Watchlist Screening 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/Riskv1decisionsProcessorInformation.md b/docs/Riskv1decisionsProcessorInformation.md deleted file mode 100644 index 4b9d5079..00000000 --- a/docs/Riskv1decisionsProcessorInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsProcessorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avs** | [**Riskv1decisionsProcessorInformationAvs**](Riskv1decisionsProcessorInformationAvs.md) | | [optional] -**card_verification** | [**Riskv1decisionsProcessorInformationCardVerification**](Riskv1decisionsProcessorInformationCardVerification.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/Riskv1decisionsProcessorInformationAvs.md b/docs/Riskv1decisionsProcessorInformationAvs.md deleted file mode 100644 index dc90b487..00000000 --- a/docs/Riskv1decisionsProcessorInformationAvs.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1decisionsProcessorInformationAvs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Value returned for address verification from the Payments Authorization response. | [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/Riskv1decisionsProcessorInformationCardVerification.md b/docs/Riskv1decisionsProcessorInformationCardVerification.md deleted file mode 100644 index 0ff7503f..00000000 --- a/docs/Riskv1decisionsProcessorInformationCardVerification.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1decisionsProcessorInformationCardVerification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**result_code** | **str** | 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/Riskv1decisionsRiskInformation.md b/docs/Riskv1decisionsRiskInformation.md deleted file mode 100644 index 154c1197..00000000 --- a/docs/Riskv1decisionsRiskInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1decisionsRiskInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**profile** | [**Ptsv2paymentsRiskInformationProfile**](Ptsv2paymentsRiskInformationProfile.md) | | [optional] -**event_type** | **str** | Specifies one of the following types of events: - login - account_creation - account_update For regular payment transactions, do not send this field. | [optional] -**buyer_history** | [**Ptsv2paymentsRiskInformationBuyerHistory**](Ptsv2paymentsRiskInformationBuyerHistory.md) | | [optional] -**auxiliary_data** | [**list[Ptsv2paymentsRiskInformationAuxiliaryData]**](Ptsv2paymentsRiskInformationAuxiliaryData.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/Riskv1decisionsTokenInformation.md b/docs/Riskv1decisionsTokenInformation.md deleted file mode 100644 index 3be7ce46..00000000 --- a/docs/Riskv1decisionsTokenInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1decisionsTokenInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**jti** | **str** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [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/Riskv1decisionsTravelInformation.md b/docs/Riskv1decisionsTravelInformation.md deleted file mode 100644 index 399b66f5..00000000 --- a/docs/Riskv1decisionsTravelInformation.md +++ /dev/null @@ -1,16 +0,0 @@ -# Riskv1decisionsTravelInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**actual_final_destination** | **str** | IATA Code for the actual final destination that the customer intends to travel to. It should be a destination on the completeRoute. | [optional] -**complete_route** | **str** | Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn], for example, SFO-JFK:JFK-LHR:LHR-CDG. For airport codes, see the IATA Airline and Airport Code Search. Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the value of _complete_route takes precedence over that of the _leg# fields. | [optional] -**departure_time** | **str** | Departure date and time of the first leg of the trip. Use one of the following formats: - yyyy-MM-dd HH:mm z - yyyy-MM-dd hh:mm a z - yyyy-MM-dd hh:mma z HH = hour in 24-hour format hh = hour in 12-hour format a = am or pm (case insensitive) z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure. Important For travel information, use GMT instead of UTC, or use the local time zone. Examples 2011-03-20 11:30 PM PDT 2011-03-20 11:30pm GMT 2011-03-20 11:30pm GMT-05:00 Eastern Standard Time: GMT-05:00 or EST Note When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset. | [optional] -**journey_type** | **str** | Type of travel, for example one way or round trip. | [optional] -**legs** | [**list[Riskv1decisionsTravelInformationLegs]**](Riskv1decisionsTravelInformationLegs.md) | | [optional] -**number_of_passengers** | **int** | Number of passengers for whom the ticket was issued. If you do not include this field in your request, CyberSource uses a default value of 1. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] -**passengers** | [**list[Riskv1decisionsTravelInformationPassengers]**](Riskv1decisionsTravelInformationPassengers.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/Riskv1decisionsTravelInformationLegs.md b/docs/Riskv1decisionsTravelInformationLegs.md deleted file mode 100644 index 8cae2e98..00000000 --- a/docs/Riskv1decisionsTravelInformationLegs.md +++ /dev/null @@ -1,14 +0,0 @@ -# Riskv1decisionsTravelInformationLegs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**origination** | **str** | Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: `travelInformation.legs.0.origination=SFO` `travelInformation.legs.1.origination=SFO` **Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_orig` 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] -**destination** | **str** | Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see [IATA Airline and Airport Code Search](https://www.iata.org/publications/Pages/code-search.aspx). The leg number can be a positive integer from 0 to N. For example: `travelInformation.legs.0.destination=SFO` `travelInformation.legs.1.destination=SFO` **Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_dest` 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] -**carrier_code** | **str** | International Air Transport Association (IATA) code for the carrier for this leg of the trip. Required for each leg. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] -**departure_date** | **str** | Departure date for the first leg of the trip. Format: YYYYMMDD. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] -**departure_time** | **int** | Time of departure for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be `00-23` and the minutes must be `00-59`. Format: English characters only. Optional request field for travel legs. | [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/Riskv1decisionsTravelInformationPassengers.md b/docs/Riskv1decisionsTravelInformationPassengers.md deleted file mode 100644 index cada65a9..00000000 --- a/docs/Riskv1decisionsTravelInformationPassengers.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsTravelInformationPassengers - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**first_name** | **str** | First name of the passenger to whom the ticket was issued. If there are multiple passengers, include all listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] -**last_name** | **str** | Last name of the passenger to whom the ticket was issued. If there are multiple passengers, include all listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Required for American Express SafeKey (U.S.) for travel-related requests. | [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/Riskv1decisionsidactionsDecisionInformation.md b/docs/Riskv1decisionsidactionsDecisionInformation.md deleted file mode 100644 index 8bdd301e..00000000 --- a/docs/Riskv1decisionsidactionsDecisionInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1decisionsidactionsDecisionInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**decision** | **str** | Decision that will be applied to the given case. Possible values are: - `ACCEPT` - `REJECT` | [optional] -**comments** | **str** | Notes from the reviewer about the decision made to this case. | [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/Riskv1decisionsidactionsProcessingInformation.md b/docs/Riskv1decisionsidactionsProcessingInformation.md deleted file mode 100644 index 31641c64..00000000 --- a/docs/Riskv1decisionsidactionsProcessingInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1decisionsidactionsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**action_list** | **list[str]** | Follow-on action to apply to the case after the decision is successfully applied. Possible values are one of the following: - `CAPTURE` - `REVERSE` If decision is ACCEPT, then CAPTURE can be used in actionList. If decision is REJECT, then REVERSE can be 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/Riskv1decisionsidmarkingRiskInformation.md b/docs/Riskv1decisionsidmarkingRiskInformation.md deleted file mode 100644 index df8330d9..00000000 --- a/docs/Riskv1decisionsidmarkingRiskInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1decisionsidmarkingRiskInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**marking_details** | [**Riskv1decisionsidmarkingRiskInformationMarkingDetails**](Riskv1decisionsidmarkingRiskInformationMarkingDetails.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/Riskv1decisionsidmarkingRiskInformationMarkingDetails.md b/docs/Riskv1decisionsidmarkingRiskInformationMarkingDetails.md deleted file mode 100644 index 71bcb817..00000000 --- a/docs/Riskv1decisionsidmarkingRiskInformationMarkingDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1decisionsidmarkingRiskInformationMarkingDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**notes** | **str** | Notes or details that explain the reasons for marking the transaction as suspect or otherwise. | [optional] -**reason** | **str** | Reason for marking the transaction as suspect or otherwise. This field can contain one of the following values: - `fraud_chargeback:` You have received a fraud-related chargeback for the transaction. - `non_fraud_chargeback:` You have received a non-fraudulent chargeback for the transaction. - `suspected:` You believe that you will probably receive a chargeback for the transaction. - `creditback:` You issued a refund to the customer to avoid a chargeback for the transaction. | [optional] -**fields_included** | **list[str]** | This field can contain one or more of the following values. When you specify more than one value, separate them with commas (,). - `account_key_hash` - `customer_account_id` - `customer_email` - `customer_ipaddress` - `customer_phone` - `device_fingerprint` - `ship_address` If no value is specified, `account_key_hash`, `customer_email`, and `ship_address` are used by default. Note `account_key_hash` adds the field that contains the card number (`customer_cc_number`). | [optional] -**action** | **str** | This field can contain one of the following values: - add: Mark as Suspect. - clear: Clear Mark as Suspect. - hide: Remove from history. | [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/Riskv1exportcomplianceinquiriesDeviceInformation.md b/docs/Riskv1exportcomplianceinquiriesDeviceInformation.md deleted file mode 100644 index 0af76722..00000000 --- a/docs/Riskv1exportcomplianceinquiriesDeviceInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1exportcomplianceinquiriesDeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] -**host_name** | **str** | DNS resolved hostname from `ipAddress`. | [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/Riskv1exportcomplianceinquiriesExportComplianceInformation.md b/docs/Riskv1exportcomplianceinquiriesExportComplianceInformation.md deleted file mode 100644 index e5c52a38..00000000 --- a/docs/Riskv1exportcomplianceinquiriesExportComplianceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Riskv1exportcomplianceinquiriesExportComplianceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address_operator** | **str** | Parts of the customer's information that must match with an entry in the DPL (denied parties list) before a match occurs. This field can contain one of the following values: - AND: (default) The customer's name or company and the customer's address must appear in the database. - OR: The customer's name must appear in the database. - IGNORE: You want the service to detect a match only of the customer's name or company but not of the address. | [optional] -**weights** | [**Ptsv2paymentsWatchlistScreeningInformationWeights**](Ptsv2paymentsWatchlistScreeningInformationWeights.md) | | [optional] -**sanction_lists** | **list[str]** | Use this field to specify which list(s) you want checked with the request. The reply will include the list name as well as the response data. To check against multiple lists, enter multiple list codes separated by a caret (^). For more information, see \"Restricted and Denied Parties List,\" page 68. | [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/Riskv1exportcomplianceinquiriesOrderInformation.md b/docs/Riskv1exportcomplianceinquiriesOrderInformation.md deleted file mode 100644 index ea1f99c6..00000000 --- a/docs/Riskv1exportcomplianceinquiriesOrderInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Riskv1exportcomplianceinquiriesOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bill_to** | [**Riskv1exportcomplianceinquiriesOrderInformationBillTo**](Riskv1exportcomplianceinquiriesOrderInformationBillTo.md) | | [optional] -**ship_to** | [**Riskv1exportcomplianceinquiriesOrderInformationShipTo**](Riskv1exportcomplianceinquiriesOrderInformationShipTo.md) | | [optional] -**line_items** | [**list[Riskv1exportcomplianceinquiriesOrderInformationLineItems]**](Riskv1exportcomplianceinquiriesOrderInformationLineItems.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/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md deleted file mode 100644 index 406ac401..00000000 --- a/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md +++ /dev/null @@ -1,21 +0,0 @@ -# Riskv1exportcomplianceinquiriesOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | 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. | -**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] -**address3** | **str** | Additional address information (third line of the billing address) | [optional] -**address4** | **str** | Additional address information (fourth line of the billing address) | [optional] -**administrative_area** | **str** | 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] -**country** | **str** | 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. | -**locality** | **str** | 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. | -**postal_code** | **str** | 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. | -**company** | [**Riskv1exportcomplianceinquiriesOrderInformationBillToCompany**](Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md) | | [optional] -**first_name** | **str** | 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] -**last_name** | **str** | 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** | **str** | 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/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md deleted file mode 100644 index 1339ef8a..00000000 --- a/docs/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1exportcomplianceinquiriesOrderInformationBillToCompany - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Company name of person buying the product. Important: This field or billTo.firstName and billTo.lastName must be present. Else, your request will fail. | [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/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md deleted file mode 100644 index 23663c0e..00000000 --- a/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md +++ /dev/null @@ -1,17 +0,0 @@ -# Riskv1exportcomplianceinquiriesOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unit_price** | **str** | Per-item price of the product. If line items are present in the request, the unit price is a mandatory field. | [optional] -**allowed_export_countries** | **list[str]** | | [optional] -**restricted_export_countries** | **list[str]** | | [optional] -**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] -**product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] -**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [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/Riskv1exportcomplianceinquiriesOrderInformationShipTo.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationShipTo.md deleted file mode 100644 index 590468fd..00000000 --- a/docs/Riskv1exportcomplianceinquiriesOrderInformationShipTo.md +++ /dev/null @@ -1,12 +0,0 @@ -# Riskv1exportcomplianceinquiriesOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 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/Riskv1liststypeentriesBuyerInformation.md b/docs/Riskv1liststypeentriesBuyerInformation.md deleted file mode 100644 index 6c9de4ff..00000000 --- a/docs/Riskv1liststypeentriesBuyerInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1liststypeentriesBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**personal_identification** | [**list[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/Riskv1liststypeentriesClientReferenceInformation.md b/docs/Riskv1liststypeentriesClientReferenceInformation.md deleted file mode 100644 index fd8187b1..00000000 --- a/docs/Riskv1liststypeentriesClientReferenceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Riskv1liststypeentriesClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | 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. | -**comments** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**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/Riskv1liststypeentriesDeviceInformation.md b/docs/Riskv1liststypeentriesDeviceInformation.md deleted file mode 100644 index d2518fe1..00000000 --- a/docs/Riskv1liststypeentriesDeviceInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1liststypeentriesDeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] -**network_ip_address** | **str** | Network IP address of the customer (for example, 10.1.27). A network IP address includes up to 256 IP addresses. | [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/Riskv1liststypeentriesOrderInformation.md b/docs/Riskv1liststypeentriesOrderInformation.md deleted file mode 100644 index cea770fc..00000000 --- a/docs/Riskv1liststypeentriesOrderInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1liststypeentriesOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address** | [**Riskv1liststypeentriesOrderInformationAddress**](Riskv1liststypeentriesOrderInformationAddress.md) | | [optional] -**bill_to** | [**Riskv1liststypeentriesOrderInformationBillTo**](Riskv1liststypeentriesOrderInformationBillTo.md) | | [optional] -**ship_to** | [**Riskv1liststypeentriesOrderInformationShipTo**](Riskv1liststypeentriesOrderInformationShipTo.md) | | [optional] -**line_items** | [**list[Riskv1liststypeentriesOrderInformationLineItems]**](Riskv1liststypeentriesOrderInformationLineItems.md) | This array contains detailed information about individual products in 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/Riskv1liststypeentriesOrderInformationAddress.md b/docs/Riskv1liststypeentriesOrderInformationAddress.md deleted file mode 100644 index dd2a46e9..00000000 --- a/docs/Riskv1liststypeentriesOrderInformationAddress.md +++ /dev/null @@ -1,15 +0,0 @@ -# Riskv1liststypeentriesOrderInformationAddress - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | First line of the street address | [optional] -**address2** | **str** | Second line of the street address | [optional] -**locality** | **str** | City of the street address. Required when adding the address to a list. | [optional] -**country** | **str** | Country of the street address. Use the two-character codes located in the Support Center. Required if address1 is present. | [optional] -**administrative_area** | **str** | State, province, or territory of the street address. Use the two-character codes located in the Support Center. | [optional] -**postal_code** | **str** | Postal code of the street address. Required when adding the address to a list. | [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/Riskv1liststypeentriesOrderInformationBillTo.md b/docs/Riskv1liststypeentriesOrderInformationBillTo.md deleted file mode 100644 index e91c6c7a..00000000 --- a/docs/Riskv1liststypeentriesOrderInformationBillTo.md +++ /dev/null @@ -1,20 +0,0 @@ -# Riskv1liststypeentriesOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | 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] -**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] -**administrative_area** | **str** | 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] -**country** | **str** | 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] -**locality** | **str** | 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] -**postal_code** | **str** | 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] -**first_name** | **str** | 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] -**last_name** | **str** | 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] -**phone_number** | **str** | 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** | **str** | 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] -**email_domain** | **str** | 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/Riskv1liststypeentriesOrderInformationLineItems.md b/docs/Riskv1liststypeentriesOrderInformationLineItems.md deleted file mode 100644 index 755d5de8..00000000 --- a/docs/Riskv1liststypeentriesOrderInformationLineItems.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1liststypeentriesOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [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/Riskv1liststypeentriesOrderInformationShipTo.md b/docs/Riskv1liststypeentriesOrderInformationShipTo.md deleted file mode 100644 index 0f04406c..00000000 --- a/docs/Riskv1liststypeentriesOrderInformationShipTo.md +++ /dev/null @@ -1,15 +0,0 @@ -# Riskv1liststypeentriesOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [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/Riskv1liststypeentriesPaymentInformation.md b/docs/Riskv1liststypeentriesPaymentInformation.md deleted file mode 100644 index db8da6c1..00000000 --- a/docs/Riskv1liststypeentriesPaymentInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Riskv1liststypeentriesPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**Riskv1liststypeentriesPaymentInformationCard**](Riskv1liststypeentriesPaymentInformationCard.md) | | [optional] -**bank** | [**Riskv1liststypeentriesPaymentInformationBank**](Riskv1liststypeentriesPaymentInformationBank.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/Riskv1liststypeentriesPaymentInformationBank.md b/docs/Riskv1liststypeentriesPaymentInformationBank.md deleted file mode 100644 index a5e7a33c..00000000 --- a/docs/Riskv1liststypeentriesPaymentInformationBank.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1liststypeentriesPaymentInformationBank - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_number** | **str** | Customer's bank account number. You can use this field only when scoring a direct debit transaction. Use this field if you do not or are not allowed to provide the IBAN. Note Do not use the IBAN in this field. Use nly the traditional account number information. For the IBAN, use bank_iban. | [optional] -**code** | **str** | 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 specific requirements, see \"Required Bank Account Information by Country,\" | [optional] -**country** | **str** | Country where the bank is located. Use the two-character ISO codes. You can use this field only when scoring a direct debit transaction. | [optional] -**iban** | **str** | 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 specific requirements, see \"Required Bank Account Information by Country,\" | [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/Riskv1liststypeentriesPaymentInformationCard.md b/docs/Riskv1liststypeentriesPaymentInformationCard.md deleted file mode 100644 index 66fcc23e..00000000 --- a/docs/Riskv1liststypeentriesPaymentInformationCard.md +++ /dev/null @@ -1,12 +0,0 @@ -# Riskv1liststypeentriesPaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**bin** | **str** | description: The BIN is the first six digits of the card's Primary Account Number (PAN). | [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/Riskv1liststypeentriesRiskInformation.md b/docs/Riskv1liststypeentriesRiskInformation.md deleted file mode 100644 index 7266c5ec..00000000 --- a/docs/Riskv1liststypeentriesRiskInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Riskv1liststypeentriesRiskInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**marking_details** | [**Riskv1liststypeentriesRiskInformationMarkingDetails**](Riskv1liststypeentriesRiskInformationMarkingDetails.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/Riskv1liststypeentriesRiskInformationMarkingDetails.md b/docs/Riskv1liststypeentriesRiskInformationMarkingDetails.md deleted file mode 100644 index ff2f4b00..00000000 --- a/docs/Riskv1liststypeentriesRiskInformationMarkingDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# Riskv1liststypeentriesRiskInformationMarkingDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**notes** | **str** | Notes or details that explain the reasons for adding the transaction to either the positive or negative list. | [optional] -**reason** | **str** | Reason for adding the transaction to the negative list. This field can contain one of the following values: - `fraud_chargeback:` You have received a fraud-related chargeback for the transaction. - `non_fraud_chargeback:` You have received a non-fraudulent chargeback for the transaction. - `suspected:` You believe that you will probably receive a chargeback for the transaction. - `creditback:` You issued a refund to the customer to avoid a chargeback for the transaction. | [optional] -**record_name** | **str** | Name of the customer's record entered in the list. For the positive list, it is required if `action_ code`=`add_positive`. If absent from the request, `ics_risk_update` creates the value for this field by concatenating the customer's first and last names. For the negative and the review lists, `record_name`, `customer_firstname`, and `customer_lastname` are optional. | [optional] -**action** | **str** | Indicates whether to add to or remove a customer's identity from the negative or positive list. This field can contain one of the following values: - add: Add information to the list. - convert: moves the data. - delete: deletes the data from the list. | [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/SAConfig.md b/docs/SAConfig.md deleted file mode 100644 index 94fdabd1..00000000 --- a/docs/SAConfig.md +++ /dev/null @@ -1,16 +0,0 @@ -# SAConfig - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parent_profile_id** | **str** | You can group Secure Acceptance profiles under parent profiles. By changing the parent profile, you can update all profiles underneath that parent. Specify the Parent Profile ID here. | [optional] -**contact_information** | [**SAConfigContactInformation**](SAConfigContactInformation.md) | | [optional] -**notifications** | [**SAConfigNotifications**](SAConfigNotifications.md) | | [optional] -**service** | [**SAConfigService**](SAConfigService.md) | | [optional] -**payment_methods** | [**SAConfigPaymentMethods**](SAConfigPaymentMethods.md) | | [optional] -**checkout** | [**SAConfigCheckout**](SAConfigCheckout.md) | | [optional] -**payment_types** | [**SAConfigPaymentTypes**](SAConfigPaymentTypes.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/SAConfigCheckout.md b/docs/SAConfigCheckout.md deleted file mode 100644 index 308975b1..00000000 --- a/docs/SAConfigCheckout.md +++ /dev/null @@ -1,12 +0,0 @@ -# SAConfigCheckout - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_tax_amount** | **bool** | Toggles whether or not the tax amount is displayed on the Hosted Checkout. | [optional] -**template_type** | **str** | Specifies whether the Hosted Checkout is displayed as a single page form or multi page checkout. Valid values: `multi` `single` | [optional] -**return_to_merchant_site_url** | **str** | URL of the website linked to from the Secure Acceptance receipt page. Only used if the profile does not have custom receipt pages configured. | [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/SAConfigContactInformation.md b/docs/SAConfigContactInformation.md deleted file mode 100644 index ddfbbd8a..00000000 --- a/docs/SAConfigContactInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# SAConfigContactInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phone** | **str** | | [optional] -**company_name** | **str** | | [optional] -**email** | **str** | | [optional] -**name** | **str** | | [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/SAConfigNotifications.md b/docs/SAConfigNotifications.md deleted file mode 100644 index 4462e370..00000000 --- a/docs/SAConfigNotifications.md +++ /dev/null @@ -1,11 +0,0 @@ -# SAConfigNotifications - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_notifications** | [**SAConfigNotificationsMerchantNotifications**](SAConfigNotificationsMerchantNotifications.md) | | [optional] -**customer_notifications** | [**SAConfigNotificationsCustomerNotifications**](SAConfigNotificationsCustomerNotifications.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/SAConfigNotificationsCustomerNotifications.md b/docs/SAConfigNotificationsCustomerNotifications.md deleted file mode 100644 index 90fbb9f6..00000000 --- a/docs/SAConfigNotificationsCustomerNotifications.md +++ /dev/null @@ -1,16 +0,0 @@ -# SAConfigNotificationsCustomerNotifications - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_receipt_page_enabled** | **bool** | Toggles the custom receipt page, where merchants can receive the results of the transaction and display appropriate messaging. Usually set by web developers integrating to Secure Acceptance. | [optional] -**receipt_email_address** | **str** | Email address where a copy of the payer's receipt email is sent, when notificationReceiptEmailEnabled is true. | [optional] -**customer_receipt_email_enabled** | **bool** | Toggles an email receipt sent to the payer's email address on payment success. | [optional] -**custom_cancel_page** | **str** | URL to which transaction results are POSTed when the payer clicks 'Cancel' on the Hosted Checkout. Triggered when customCancelPageEnabled is true. Usually set by web developers integrating to Secure Acceptance. | [optional] -**custom_receipt_page** | **str** | URL to which transaction results are POSTed when the payer requests a payment on the Hosted Checkout. Triggered when customCancelPageEnabled is true. Usually set by web developers integrating to Secure Acceptance. | [optional] -**custom_cancel_page_enabled** | **bool** | Toggles the custom cancel page, where merchants can receive notice that the payer has canceled, and display appropriate messaging and direction. Usually set by web developers integrating to Secure Acceptance. | [optional] -**notification_receipt_email_enabled** | **bool** | Toggles whether merchant receives a copy of the payer's receipt email. | [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/SAConfigNotificationsMerchantNotifications.md b/docs/SAConfigNotificationsMerchantNotifications.md deleted file mode 100644 index e8d164a8..00000000 --- a/docs/SAConfigNotificationsMerchantNotifications.md +++ /dev/null @@ -1,14 +0,0 @@ -# SAConfigNotificationsMerchantNotifications - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backoffice_post_enabled** | **bool** | Enables Webhook transaction confirmation messages sent to URL defined in backofficePostUrl. Usually enabled by web developers integrating to Secure Acceptance. | [optional] -**backoffice_email_address** | **str** | Email address to receive transaction confirmation messages. | [optional] -**backoffice_email_enabled** | **bool** | Enables email transaction confirmation messages, sent to the address specified in backofficeEmailAddress. | [optional] -**backoffice_post_url** | **str** | Webhook URL to which transaction confirmation is sent. Usually completed by the web developers integrating to Secure Acceptance. | [optional] -**card_number_format** | **str** | Format in which the card number should be masked in the notifications. Valid values: `1` - Display first 6 digits only (e.g. \"444433**********\") `2` - Display last four digits only (e.g. \"************1111\") `3` - Display First six and last four digits (e.g. \"444433******1111\") | [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/SAConfigPaymentMethods.md b/docs/SAConfigPaymentMethods.md deleted file mode 100644 index cfb7bae8..00000000 --- a/docs/SAConfigPaymentMethods.md +++ /dev/null @@ -1,10 +0,0 @@ -# SAConfigPaymentMethods - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled_payment_methods** | **list[str]** | | [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/SAConfigPaymentTypes.md b/docs/SAConfigPaymentTypes.md deleted file mode 100644 index 46affd03..00000000 --- a/docs/SAConfigPaymentTypes.md +++ /dev/null @@ -1,10 +0,0 @@ -# SAConfigPaymentTypes - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card_types** | [**SAConfigPaymentTypesCardTypes**](SAConfigPaymentTypesCardTypes.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/SAConfigPaymentTypesCardTypes.md b/docs/SAConfigPaymentTypesCardTypes.md deleted file mode 100644 index 04a436aa..00000000 --- a/docs/SAConfigPaymentTypesCardTypes.md +++ /dev/null @@ -1,13 +0,0 @@ -# SAConfigPaymentTypesCardTypes - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**discover** | [**SAConfigPaymentTypesCardTypesDiscover**](SAConfigPaymentTypesCardTypesDiscover.md) | | [optional] -**amex** | [**SAConfigPaymentTypesCardTypesDiscover**](SAConfigPaymentTypesCardTypesDiscover.md) | | [optional] -**master_card** | [**SAConfigPaymentTypesCardTypesDiscover**](SAConfigPaymentTypesCardTypesDiscover.md) | | [optional] -**visa** | [**SAConfigPaymentTypesCardTypesDiscover**](SAConfigPaymentTypesCardTypesDiscover.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/SAConfigPaymentTypesCardTypesDiscover.md b/docs/SAConfigPaymentTypesCardTypesDiscover.md deleted file mode 100644 index f53d8305..00000000 --- a/docs/SAConfigPaymentTypesCardTypesDiscover.md +++ /dev/null @@ -1,16 +0,0 @@ -# SAConfigPaymentTypesCardTypesDiscover - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card_verification_number_supported** | **bool** | Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level. | [optional] -**card_verification_number_display** | **bool** | Toggles whether or Card Verification Number is displayed on the Hosted Checkout. | [optional] -**payer_authentication_supported** | **bool** | Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level. | [optional] -**supported_currencies** | **list[str]** | Array of the supported ISO 4217 alphabetic currency codes. | [optional] -**method** | **str** | | [optional] -**card_verification_number_required** | **bool** | | [optional] -**payer_authentication_enabled** | **bool** | | [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/SAConfigService.md b/docs/SAConfigService.md deleted file mode 100644 index cc4a4815..00000000 --- a/docs/SAConfigService.md +++ /dev/null @@ -1,16 +0,0 @@ -# SAConfigService - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**decision_manager_verbose_enabled** | **bool** | Toggles whether verbose Decision Manager results should be present in the Secure Acceptance response. As this response passes through the browser, it is recommended to set this to \"false\" outside of debugging. | [optional] -**declined_retry_limit** | **float** | Defines the number of retries a payer is presented with on payment declines on Hosted Checkout. Valid values are between 0 and 5. | [optional] -**decision_manager_enabled** | **bool** | Toggles whether Decision Manager is enabled or not for Secure Acceptance transactions. Requires the transacting MID to be enabled and configured for Decicion Manager. | [optional] -**tokenization_enabled** | **bool** | Toggles whether Tokenization is enabled or not for Secure Acceptance transactions. Requires the transacting MID to be enabled and configured for Tokenization. | [optional] -**reverse_auth_on_address_verification_system_failure** | **bool** | Toggles whether or not an approved Authorization that fails AVS should be automatically reversed. | [optional] -**device_fingerprint_enabled** | **bool** | Toggles whether or not fraud Device Fingerprinting is enabled on the Hosted Checkout. This simplifies enablement for Decision Manager. | [optional] -**reverse_auth_on_card_verification_number_failure** | **bool** | Toggles whether or not an approved Authorization that fails CVN check that should be automatically reversed. | [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/SaveAsymEgressKey.md b/docs/SaveAsymEgressKey.md deleted file mode 100644 index ce800c9f..00000000 --- a/docs/SaveAsymEgressKey.md +++ /dev/null @@ -1,12 +0,0 @@ -# SaveAsymEgressKey - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Kmsegressv2keysasymClientReferenceInformation**](Kmsegressv2keysasymClientReferenceInformation.md) | | [optional] -**client_request_action** | **str** | Client request action. | [optional] -**key_information** | [**Kmsegressv2keysasymKeyInformation**](Kmsegressv2keysasymKeyInformation.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/SaveSymEgressKey.md b/docs/SaveSymEgressKey.md deleted file mode 100644 index 1ea84716..00000000 --- a/docs/SaveSymEgressKey.md +++ /dev/null @@ -1,12 +0,0 @@ -# SaveSymEgressKey - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Kmsegressv2keyssymClientReferenceInformation**](Kmsegressv2keyssymClientReferenceInformation.md) | | [optional] -**client_request_action** | **str** | Client request action. | [optional] -**key_information** | [**Kmsegressv2keyssymKeyInformation**](Kmsegressv2keyssymKeyInformation.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/SearchRequest.md b/docs/SearchRequest.md deleted file mode 100644 index 1843a410..00000000 --- a/docs/SearchRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | This is the orgId of the organization which the user belongs to. | [optional] -**user_name** | **str** | User ID of the user you want to get details on. | [optional] -**role_id** | **str** | role of the user you are trying to search on. | [optional] -**permission_id** | **str** | permission that you are trying to search user on. | [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/SearchTransactionsApi.md b/docs/SearchTransactionsApi.md deleted file mode 100644 index 803a3973..00000000 --- a/docs/SearchTransactionsApi.md +++ /dev/null @@ -1,106 +0,0 @@ -# CyberSource.SearchTransactionsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_search**](SearchTransactionsApi.md#create_search) | **POST** /tss/v2/searches | Create a Search Request -[**get_search**](SearchTransactionsApi.md#get_search) | **GET** /tss/v2/searches/{searchId} | Get Search Results - - -# **create_search** -> TssV2TransactionsPost201Response create_search(create_search_request) - -Create a Search Request - -Create a search request. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SearchTransactionsApi() -create_search_request = CyberSource.CreateSearchRequest() # CreateSearchRequest | - -try: - # Create a Search Request - api_response = api_instance.create_search(create_search_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling SearchTransactionsApi->create_search: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **create_search_request** | [**CreateSearchRequest**](CreateSearchRequest.md)| | - -### Return type - -[**TssV2TransactionsPost201Response**](TssV2TransactionsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_search** -> TssV2TransactionsPost201Response get_search(search_id) - -Get Search Results - -Include the Search ID in the GET request to retrieve the search results. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SearchTransactionsApi() -search_id = 'search_id_example' # str | Search ID. - -try: - # Get Search Results - api_response = api_instance.get_search(search_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling SearchTransactionsApi->get_search: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **search_id** | **str**| Search ID. | - -### Return type - -[**TssV2TransactionsPost201Response**](TssV2TransactionsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: */* - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SecureFileShareApi.md b/docs/SecureFileShareApi.md deleted file mode 100644 index de76750b..00000000 --- a/docs/SecureFileShareApi.md +++ /dev/null @@ -1,113 +0,0 @@ -# CyberSource.SecureFileShareApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_file**](SecureFileShareApi.md#get_file) | **GET** /sfs/v1/files/{fileId} | Download a File with File Identifier -[**get_file_detail**](SecureFileShareApi.md#get_file_detail) | **GET** /sfs/v1/file-details | Get List of Files - - -# **get_file** -> get_file(file_id, organization_id=organization_id) - -Download a File with File Identifier - -Download a file for the given file identifier - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SecureFileShareApi() -file_id = 'file_id_example' # str | Unique identifier for each file -organization_id = 'organization_id_example' # str | Valid Cybersource Organization Id (optional) - -try: - # Download a File with File Identifier - api_instance.get_file(file_id, organization_id=organization_id) -except ApiException as e: - print("Exception when calling SecureFileShareApi->get_file: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_id** | **str**| Unique identifier for each file | - **organization_id** | **str**| Valid Cybersource Organization Id | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: */*;charset=utf-8 - - **Accept**: application/xml, text/csv, application/pdf - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_file_detail** -> V1FileDetailsGet200Response get_file_detail(start_date, end_date, organization_id=organization_id, name=name) - -Get List of Files - -Get list of files and it's information of them available inside the report directory - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SecureFileShareApi() -start_date = '2013-10-20' # date | Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd -end_date = '2013-10-20' # date | Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd -organization_id = 'organization_id_example' # str | Valid Cybersource Organization Id (optional) -name = 'name_example' # str | **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml (optional) - -try: - # Get List of Files - api_response = api_instance.get_file_detail(start_date, end_date, organization_id=organization_id, name=name) - pprint(api_response) -except ApiException as e: - print("Exception when calling SecureFileShareApi->get_file_detail: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_date** | **date**| Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd | - **end_date** | **date**| Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd | - **organization_id** | **str**| Valid Cybersource Organization Id | [optional] - **name** | **str**| **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml | [optional] - -### Return type - -[**V1FileDetailsGet200Response**](V1FileDetailsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: */*;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/ShippingAddressListForCustomer.md b/docs/ShippingAddressListForCustomer.md deleted file mode 100644 index 79d00801..00000000 --- a/docs/ShippingAddressListForCustomer.md +++ /dev/null @@ -1,15 +0,0 @@ -# ShippingAddressListForCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**ShippingAddressListForCustomerLinks**](ShippingAddressListForCustomerLinks.md) | | [optional] -**offset** | **int** | The offset parameter supplied in the request. | [optional] -**limit** | **int** | The limit parameter supplied in the request. | [optional] -**count** | **int** | The number of Shipping Addresses returned in the array. | [optional] -**total** | **int** | The total number of Shipping Addresses associated with the Customer. | [optional] -**embedded** | [**ShippingAddressListForCustomerEmbedded**](ShippingAddressListForCustomerEmbedded.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/ShippingAddressListForCustomerEmbedded.md b/docs/ShippingAddressListForCustomerEmbedded.md deleted file mode 100644 index b7454995..00000000 --- a/docs/ShippingAddressListForCustomerEmbedded.md +++ /dev/null @@ -1,10 +0,0 @@ -# ShippingAddressListForCustomerEmbedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**shipping_addresses** | [**list[Tmsv2customersEmbeddedDefaultShippingAddress]**](Tmsv2customersEmbeddedDefaultShippingAddress.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/ShippingAddressListForCustomerLinks.md b/docs/ShippingAddressListForCustomerLinks.md deleted file mode 100644 index 64bc8194..00000000 --- a/docs/ShippingAddressListForCustomerLinks.md +++ /dev/null @@ -1,14 +0,0 @@ -# ShippingAddressListForCustomerLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**ShippingAddressListForCustomerLinksSelf**](ShippingAddressListForCustomerLinksSelf.md) | | [optional] -**first** | [**ShippingAddressListForCustomerLinksFirst**](ShippingAddressListForCustomerLinksFirst.md) | | [optional] -**prev** | [**ShippingAddressListForCustomerLinksPrev**](ShippingAddressListForCustomerLinksPrev.md) | | [optional] -**next** | [**ShippingAddressListForCustomerLinksNext**](ShippingAddressListForCustomerLinksNext.md) | | [optional] -**last** | [**ShippingAddressListForCustomerLinksLast**](ShippingAddressListForCustomerLinksLast.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/ShippingAddressListForCustomerLinksFirst.md b/docs/ShippingAddressListForCustomerLinksFirst.md deleted file mode 100644 index 59254eae..00000000 --- a/docs/ShippingAddressListForCustomerLinksFirst.md +++ /dev/null @@ -1,10 +0,0 @@ -# ShippingAddressListForCustomerLinksFirst - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the first page. | [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/ShippingAddressListForCustomerLinksLast.md b/docs/ShippingAddressListForCustomerLinksLast.md deleted file mode 100644 index abbdeba7..00000000 --- a/docs/ShippingAddressListForCustomerLinksLast.md +++ /dev/null @@ -1,10 +0,0 @@ -# ShippingAddressListForCustomerLinksLast - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the last page. | [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/ShippingAddressListForCustomerLinksNext.md b/docs/ShippingAddressListForCustomerLinksNext.md deleted file mode 100644 index 62f7e702..00000000 --- a/docs/ShippingAddressListForCustomerLinksNext.md +++ /dev/null @@ -1,10 +0,0 @@ -# ShippingAddressListForCustomerLinksNext - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the next page. | [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/ShippingAddressListForCustomerLinksPrev.md b/docs/ShippingAddressListForCustomerLinksPrev.md deleted file mode 100644 index 1db7ac7f..00000000 --- a/docs/ShippingAddressListForCustomerLinksPrev.md +++ /dev/null @@ -1,10 +0,0 @@ -# ShippingAddressListForCustomerLinksPrev - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the previous page. | [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/ShippingAddressListForCustomerLinksSelf.md b/docs/ShippingAddressListForCustomerLinksSelf.md deleted file mode 100644 index 76f39df2..00000000 --- a/docs/ShippingAddressListForCustomerLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# ShippingAddressListForCustomerLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the current page. | [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/SubscriptionsApi.md b/docs/SubscriptionsApi.md deleted file mode 100644 index 57148b82..00000000 --- a/docs/SubscriptionsApi.md +++ /dev/null @@ -1,406 +0,0 @@ -# CyberSource.SubscriptionsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**activate_subscription**](SubscriptionsApi.md#activate_subscription) | **POST** /rbs/v1/subscriptions/{id}/activate | Activate a Subscription -[**cancel_subscription**](SubscriptionsApi.md#cancel_subscription) | **POST** /rbs/v1/subscriptions/{id}/cancel | Cancel a Subscription -[**create_subscription**](SubscriptionsApi.md#create_subscription) | **POST** /rbs/v1/subscriptions | Create a Subscription -[**get_all_subscriptions**](SubscriptionsApi.md#get_all_subscriptions) | **GET** /rbs/v1/subscriptions | Get a List of Subscriptions -[**get_subscription**](SubscriptionsApi.md#get_subscription) | **GET** /rbs/v1/subscriptions/{id} | Get a Subscription -[**get_subscription_code**](SubscriptionsApi.md#get_subscription_code) | **GET** /rbs/v1/subscriptions/code | Get a Subscription Code -[**suspend_subscription**](SubscriptionsApi.md#suspend_subscription) | **POST** /rbs/v1/subscriptions/{id}/suspend | Suspend a Subscription -[**update_subscription**](SubscriptionsApi.md#update_subscription) | **PATCH** /rbs/v1/subscriptions/{id} | Update a Subscription - - -# **activate_subscription** -> ActivateSubscriptionResponse activate_subscription(id, process_skipped_payments=process_skipped_payments) - -Activate a Subscription - -Activate a `SUSPENDED` Subscription - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsApi() -id = 'id_example' # str | Subscription Id -process_skipped_payments = true # bool | Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. (optional) (default to true) - -try: - # Activate a Subscription - api_response = api_instance.activate_subscription(id, process_skipped_payments=process_skipped_payments) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsApi->activate_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Subscription Id | - **process_skipped_payments** | **bool**| Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. | [optional] [default to true] - -### Return type - -[**ActivateSubscriptionResponse**](ActivateSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **cancel_subscription** -> CancelSubscriptionResponse cancel_subscription(id) - -Cancel a Subscription - -Cancel a Subscription - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsApi() -id = 'id_example' # str | Subscription Id - -try: - # Cancel a Subscription - api_response = api_instance.cancel_subscription(id) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsApi->cancel_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Subscription Id | - -### Return type - -[**CancelSubscriptionResponse**](CancelSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_subscription** -> CreateSubscriptionResponse create_subscription(create_subscription_request) - -Create a Subscription - -Create a Recurring Billing Subscription - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsApi() -create_subscription_request = CyberSource.CreateSubscriptionRequest() # CreateSubscriptionRequest | - -try: - # Create a Subscription - api_response = api_instance.create_subscription(create_subscription_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsApi->create_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **create_subscription_request** | [**CreateSubscriptionRequest**](CreateSubscriptionRequest.md)| | - -### Return type - -[**CreateSubscriptionResponse**](CreateSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_subscriptions** -> GetAllSubscriptionsResponse get_all_subscriptions(offset=offset, limit=limit, code=code, status=status) - -Get a List of Subscriptions - -Retrieve Subscriptions by Subscription Code & Subscription Status. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsApi() -offset = 56 # int | Page offset number. (optional) -limit = 56 # int | Number of items to be returned. Default - `20`, Max - `100` (optional) -code = 'code_example' # str | Filter by Subscription Code (optional) -status = 'status_example' # str | Filter by Subscription Status (optional) - -try: - # Get a List of Subscriptions - api_response = api_instance.get_all_subscriptions(offset=offset, limit=limit, code=code, status=status) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsApi->get_all_subscriptions: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **offset** | **int**| Page offset number. | [optional] - **limit** | **int**| Number of items to be returned. Default - `20`, Max - `100` | [optional] - **code** | **str**| Filter by Subscription Code | [optional] - **status** | **str**| Filter by Subscription Status | [optional] - -### Return type - -[**GetAllSubscriptionsResponse**](GetAllSubscriptionsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_subscription** -> GetSubscriptionResponse get_subscription(id) - -Get a Subscription - -Get a Subscription by Subscription Id - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsApi() -id = 'id_example' # str | Subscription Id - -try: - # Get a Subscription - api_response = api_instance.get_subscription(id) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsApi->get_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Subscription Id | - -### Return type - -[**GetSubscriptionResponse**](GetSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_subscription_code** -> GetSubscriptionCodeResponse get_subscription_code() - -Get a Subscription Code - -Get a Unique Subscription Code - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsApi() - -try: - # Get a Subscription Code - api_response = api_instance.get_subscription_code() - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsApi->get_subscription_code: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**GetSubscriptionCodeResponse**](GetSubscriptionCodeResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **suspend_subscription** -> SuspendSubscriptionResponse suspend_subscription(id) - -Suspend a Subscription - -Suspend a Subscription - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsApi() -id = 'id_example' # str | Subscription Id - -try: - # Suspend a Subscription - api_response = api_instance.suspend_subscription(id) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsApi->suspend_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Subscription Id | - -### Return type - -[**SuspendSubscriptionResponse**](SuspendSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_subscription** -> UpdateSubscriptionResponse update_subscription(id, update_subscription) - -Update a Subscription - -Update a Subscription by Subscription Id - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsApi() -id = 'id_example' # str | Subscription Id -update_subscription = CyberSource.UpdateSubscription() # UpdateSubscription | Update Subscription - -try: - # Update a Subscription - api_response = api_instance.update_subscription(id, update_subscription) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsApi->update_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Subscription Id | - **update_subscription** | [**UpdateSubscription**](UpdateSubscription.md)| Update Subscription | - -### Return type - -[**UpdateSubscriptionResponse**](UpdateSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionsFollowOnsApi.md b/docs/SubscriptionsFollowOnsApi.md deleted file mode 100644 index d1fe3910..00000000 --- a/docs/SubscriptionsFollowOnsApi.md +++ /dev/null @@ -1,108 +0,0 @@ -# CyberSource.SubscriptionsFollowOnsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_follow_on_subscription**](SubscriptionsFollowOnsApi.md#create_follow_on_subscription) | **POST** /rbs/v1/subscriptions/follow-ons/{requestId} | Create a Follow-On Subscription -[**get_follow_on_subscription**](SubscriptionsFollowOnsApi.md#get_follow_on_subscription) | **GET** /rbs/v1/subscriptions/follow-ons/{requestId} | Get a Follow-On Subscription - - -# **create_follow_on_subscription** -> CreateSubscriptionResponse create_follow_on_subscription(request_id, create_subscription_request) - -Create a Follow-On Subscription - -Create a new Subscription based on the Request Id of an existing successful Transaction. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsFollowOnsApi() -request_id = 'request_id_example' # str | Request Id of an existing successful Transaction -create_subscription_request = CyberSource.CreateSubscriptionRequest1() # CreateSubscriptionRequest1 | - -try: - # Create a Follow-On Subscription - api_response = api_instance.create_follow_on_subscription(request_id, create_subscription_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsFollowOnsApi->create_follow_on_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request_id** | **str**| Request Id of an existing successful Transaction | - **create_subscription_request** | [**CreateSubscriptionRequest1**](CreateSubscriptionRequest1.md)| | - -### Return type - -[**CreateSubscriptionResponse**](CreateSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_follow_on_subscription** -> GetSubscriptionResponse1 get_follow_on_subscription(request_id) - -Get a Follow-On Subscription - -Get details of the Subscription being created based on the Request Id of an existing successful Transaction. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.SubscriptionsFollowOnsApi() -request_id = 'request_id_example' # str | Request Id of an existing successful Transaction - -try: - # Get a Follow-On Subscription - api_response = api_instance.get_follow_on_subscription(request_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling SubscriptionsFollowOnsApi->get_follow_on_subscription: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request_id** | **str**| Request Id of an existing successful Transaction | - -### Return type - -[**GetSubscriptionResponse1**](GetSubscriptionResponse1.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SuspendSubscriptionResponse.md b/docs/SuspendSubscriptionResponse.md deleted file mode 100644 index 13e87be6..00000000 --- a/docs/SuspendSubscriptionResponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# SuspendSubscriptionResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - ACCEPTED | [optional] -**subscription_information** | [**SuspendSubscriptionResponseSubscriptionInformation**](SuspendSubscriptionResponseSubscriptionInformation.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/SuspendSubscriptionResponseSubscriptionInformation.md b/docs/SuspendSubscriptionResponseSubscriptionInformation.md deleted file mode 100644 index 4e71202d..00000000 --- a/docs/SuspendSubscriptionResponseSubscriptionInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# SuspendSubscriptionResponseSubscriptionInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Subscription code. | [optional] -**status** | **str** | Subscription Status: - `SUSPENDED` | [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/TaxRequest.md b/docs/TaxRequest.md deleted file mode 100644 index ce890e69..00000000 --- a/docs/TaxRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# TaxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Vasv2taxClientReferenceInformation**](Vasv2taxClientReferenceInformation.md) | | [optional] -**tax_information** | [**Vasv2taxTaxInformation**](Vasv2taxTaxInformation.md) | | [optional] -**order_information** | [**Vasv2taxOrderInformation**](Vasv2taxOrderInformation.md) | | [optional] -**merchant_information** | [**Vasv2taxMerchantInformation**](Vasv2taxMerchantInformation.md) | | [optional] -**buyer_information** | [**Vasv2taxBuyerInformation**](Vasv2taxBuyerInformation.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/TaxesApi.md b/docs/TaxesApi.md deleted file mode 100644 index e7f42d02..00000000 --- a/docs/TaxesApi.md +++ /dev/null @@ -1,108 +0,0 @@ -# CyberSource.TaxesApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**calculate_tax**](TaxesApi.md#calculate_tax) | **POST** /vas/v2/tax | Calculate Taxes -[**void_tax**](TaxesApi.md#void_tax) | **PATCH** /vas/v2/tax/{id} | Void Taxes - - -# **calculate_tax** -> VasV2PaymentsPost201Response calculate_tax(tax_request) - -Calculate Taxes - -The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide. It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation. The service supports product-based tax rules and exemptions for goods and services. The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TaxesApi() -tax_request = CyberSource.TaxRequest() # TaxRequest | - -try: - # Calculate Taxes - api_response = api_instance.calculate_tax(tax_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling TaxesApi->calculate_tax: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tax_request** | [**TaxRequest**](TaxRequest.md)| | - -### Return type - -[**VasV2PaymentsPost201Response**](VasV2PaymentsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **void_tax** -> VasV2TaxVoid200Response void_tax(void_tax_request, id) - -Void Taxes - -Pass the Tax Request ID in the PATCH request to void the committed tax calculation. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TaxesApi() -void_tax_request = CyberSource.VoidTaxRequest() # VoidTaxRequest | -id = 'id_example' # str | The tax ID returned from a previous request. - -try: - # Void Taxes - api_response = api_instance.void_tax(void_tax_request, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling TaxesApi->void_tax: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **void_tax_request** | [**VoidTaxRequest**](VoidTaxRequest.md)| | - **id** | **str**| The tax ID returned from a previous request. | - -### Return type - -[**VasV2TaxVoid200Response**](VasV2TaxVoid200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TmsAuthorizationOptions.md b/docs/TmsAuthorizationOptions.md deleted file mode 100644 index d52d8789..00000000 --- a/docs/TmsAuthorizationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsAuthorizationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**initiator** | [**TmsAuthorizationOptionsInitiator**](TmsAuthorizationOptionsInitiator.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/TmsAuthorizationOptionsInitiator.md b/docs/TmsAuthorizationOptionsInitiator.md deleted file mode 100644 index 9a2467bd..00000000 --- a/docs/TmsAuthorizationOptionsInitiator.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsAuthorizationOptionsInitiator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_initiated_transaction** | [**TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.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/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md deleted file mode 100644 index ffdcf604..00000000 --- a/docs/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**previous_transaction_id** | **str** | 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. | [optional] -**original_authorized_amount** | **str** | Amount of the original authorization. | [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/TmsBinLookup.md b/docs/TmsBinLookup.md deleted file mode 100644 index a86ea12f..00000000 --- a/docs/TmsBinLookup.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsBinLookup - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_account_information** | [**TmsBinLookupPaymentAccountInformation**](TmsBinLookupPaymentAccountInformation.md) | | [optional] -**issuer_information** | [**TmsBinLookupIssuerInformation**](TmsBinLookupIssuerInformation.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/TmsBinLookupIssuerInformation.md b/docs/TmsBinLookupIssuerInformation.md deleted file mode 100644 index 647d3607..00000000 --- a/docs/TmsBinLookupIssuerInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# TmsBinLookupIssuerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | This field contains the issuer name. | [optional] -**country** | **str** | This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. | [optional] -**bin_length** | **str** | This field contains the length of the BIN. In some cases, this field may be absent if we do not receive accurate information from the network source. | [optional] -**account_prefix** | **str** | This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).In case the input is not the full intrument (PAN or TOKEN), this field may be truncated. | [optional] -**phone_number** | **str** | This field contains the customer service phone number for the issuer. | [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/TmsBinLookupPaymentAccountInformation.md b/docs/TmsBinLookupPaymentAccountInformation.md deleted file mode 100644 index cd4c4287..00000000 --- a/docs/TmsBinLookupPaymentAccountInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# TmsBinLookupPaymentAccountInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**TmsBinLookupPaymentAccountInformationCard**](TmsBinLookupPaymentAccountInformationCard.md) | | [optional] -**features** | [**TmsBinLookupPaymentAccountInformationFeatures**](TmsBinLookupPaymentAccountInformationFeatures.md) | | [optional] -**network** | [**TmsBinLookupPaymentAccountInformationNetwork**](TmsBinLookupPaymentAccountInformationNetwork.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/TmsBinLookupPaymentAccountInformationCard.md b/docs/TmsBinLookupPaymentAccountInformationCard.md deleted file mode 100644 index 2d4d59b8..00000000 --- a/docs/TmsBinLookupPaymentAccountInformationCard.md +++ /dev/null @@ -1,15 +0,0 @@ -# TmsBinLookupPaymentAccountInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system. Possible values from BIN Lookup Service (based on availability and enablement): - `000`: Unsupported Card Type - `001`: Visa - `002`: Mastercard - `003`: American Express - `004`: Discover - `005`: Diners Club - `007`: JCB - `036`: Cartes Bancaire - `042`: Maestro - `054`: Elo - `058`: Carnet - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `064`: Prompt Card - `067`: Meeza - `068`: PayPak - `070`: EFTPOS - `081`: Jaywan - `082`: TPN Glossary of possible values in the payments ecosystem: - `001`: Visa - `002`: Mastercard - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche - `007`: JCB - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: EnRoute - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL - `023`: Disney Card - `024`: Switch/Solo - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron - `034`: Dankort - `035`: Laser - `036`: Cartes Bancaire - `037`: Carta Si - `040`: UATP - `041`: HOUSEHOLD - `042`: Maestro - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: J.Crew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo - `055`: Capital One Private Label - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: Meeza - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan - `082`: TPN | [optional] -**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - MADA - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS - MEEZA - PAYPAK - JAYWAN - TPN | [optional] -**currency** | **str** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional] -**max_length** | **str** | This field contains the max length of the card. | [optional] -**credential_type** | **str** | This field contains the type of the payment credential. Possible values: - PAN - TOKEN | [optional] -**brands** | [**list[TmsBinLookupPaymentAccountInformationCardBrands]**](TmsBinLookupPaymentAccountInformationCardBrands.md) | Array of brands | [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/TmsBinLookupPaymentAccountInformationCardBrands.md b/docs/TmsBinLookupPaymentAccountInformationCardBrands.md deleted file mode 100644 index ca5c8ad9..00000000 --- a/docs/TmsBinLookupPaymentAccountInformationCardBrands.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsBinLookupPaymentAccountInformationCardBrands - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system. Possible values from BIN Lookup Service (based on availability and enablement): - `000`: Unsupported Card Type - `001`: Visa - `002`: Mastercard - `003`: American Express - `004`: Discover - `005`: Diners Club - `007`: JCB - `036`: Cartes Bancaire - `042`: Maestro - `054`: Elo - `058`: Carnet - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `064`: Prompt Card - `067`: Meeza - `068`: PayPak - `070`: EFTPOS - `081`: Jaywan - `082`: TPN Glossary of possible values in the payments ecosystem: - `001`: Visa - `002`: Mastercard - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche - `007`: JCB - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: EnRoute - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL - `023`: Disney Card - `024`: Switch/Solo - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron - `034`: Dankort - `035`: Laser - `036`: Cartes Bancaire - `037`: Carta Si - `040`: UATP - `041`: HOUSEHOLD - `042`: Maestro - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: J.Crew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo - `055`: Capital One Private Label - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: Meeza - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan - `082`: TPN | [optional] -**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - MADA - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS - MEEZA - PAYPAK - JAYWAN - TPN | [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/TmsBinLookupPaymentAccountInformationFeatures.md b/docs/TmsBinLookupPaymentAccountInformationFeatures.md deleted file mode 100644 index 9381bdf4..00000000 --- a/docs/TmsBinLookupPaymentAccountInformationFeatures.md +++ /dev/null @@ -1,28 +0,0 @@ -# TmsBinLookupPaymentAccountInformationFeatures - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_funding_source** | **str** | This field contains the account funding source. Possible values: - `CREDIT` - `DEBIT` - `PREPAID` - `DEFERRED DEBIT` - `CHARGE` | [optional] -**account_funding_source_sub_type** | **str** | This field contains the type of prepaid card. Possible values: - `Reloadable` - `Non-reloadable` | [optional] -**card_product** | **str** | This field contains the type of issuer product. Example values: - Visa Classic - Visa Signature - Visa Infinite | [optional] -**message_type** | **str** | This field contains the type of BIN based authentication. Possible values: - `S`: Single Message - `D`: Dual Message | [optional] -**acceptance_level** | **str** | This field contains the acceptance level of the PAN. Possible values: - `0` : Normal - `1` : Monitor - `2` : Refuse - `3` : Not Allowed - `4` : Private - `5` : Test | [optional] -**card_platform** | **str** | This field contains the type of card platform. Possible values: - `BUSINESS` - `CONSUMER` - `CORPORATE` - `COMMERCIAL` - `GOVERNMENT` | [optional] -**combo_card** | **str** | This field indicates the type of combo card. Possible values: - 0 (Not a combo card) - 1 (Credit and Prepaid Combo card) - 2 (Credit and Debit Combo card) - 3 (Prepaid Credit and Prepaid Debit combo card) | [optional] -**corporate_purchase** | **bool** | This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards. Possible values: - `true` - `false` | [optional] -**health_card** | **bool** | This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs. Possible values: - `true` - `false` | [optional] -**shared_bin** | **bool** | This field indicates if the BIN is shared by multiple issuers Possible values: - `true` - `false` | [optional] -**pos_domestic_only** | **bool** | This field indicates if the BIN is valid only for POS domestic usage. Possible values: - `true` - `false` | [optional] -**gambling_allowed** | **bool** | This field indicates if gambling transactions are allowed on the BIN. Possible values: - `true` - `false` | [optional] -**commercial_card_level2** | **bool** | This field indicates if a transaction on the instrument qualifies for level 2 interchange rates. Possible values: - `true` - `false` | [optional] -**commercial_card_level3** | **bool** | This field indicates if a transaction on the instrument qualifies for level 3 interchange rates. Possible values: - `true` - `false` | [optional] -**exempt_bin** | **bool** | This field indicates if a transaction on the instrument qualifies for government exempt interchange fee. Possible values: - `true` - `false` | [optional] -**account_level_management** | **bool** | This field indicates if the BIN participates in Account Level Management (ALM). Possible values: - `true` - `false` | [optional] -**online_gambling_block** | **bool** | This field indicates if online gambling is blocked on the BIN. Possible values: - `true` - `false` | [optional] -**auto_substantiation** | **bool** | This field indicates if auto-substantiation is enabled on the BIN. Possible values: - `true` - `false` | [optional] -**flex_credential** | **bool** | This field indicates if the instrument is a flex credential. Possible values: - `true` - `false` | [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/TmsBinLookupPaymentAccountInformationNetwork.md b/docs/TmsBinLookupPaymentAccountInformationNetwork.md deleted file mode 100644 index 7a0edf96..00000000 --- a/docs/TmsBinLookupPaymentAccountInformationNetwork.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsBinLookupPaymentAccountInformationNetwork - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | This field contains a code that identifies the network. [List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_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/TmsBusinessInformation.md b/docs/TmsBusinessInformation.md deleted file mode 100644 index cafd1cdd..00000000 --- a/docs/TmsBusinessInformation.md +++ /dev/null @@ -1,16 +0,0 @@ -# TmsBusinessInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the network token merchant. | [optional] -**doing_business_as** | **str** | Name the network token merchant does business as | [optional] -**address** | [**TmsBusinessInformationAddress**](TmsBusinessInformationAddress.md) | | [optional] -**website_url** | **str** | Website of network token merchant. | [optional] -**business_identification_type** | **str** | The Identifier associated with the business type; required unless both acquirerId and acquirerMerchantId are provided. | [optional] -**business_identification_value** | **str** | The value associated with the business identifier type; required unless both acquirerId and acquirerMerchantId are provided. | [optional] -**acquirer** | [**TmsBusinessInformationAcquirer**](TmsBusinessInformationAcquirer.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/TmsBusinessInformationAcquirer.md b/docs/TmsBusinessInformationAcquirer.md deleted file mode 100644 index 7424c2dc..00000000 --- a/docs/TmsBusinessInformationAcquirer.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsBusinessInformationAcquirer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**acquirer_id** | **str** | Acquirer ID; required unless both businessIdentificationType and businessIdentificationValue are provided. | [optional] -**acquirer_merchant_id** | **str** | Acquirer merchant ID; required unless both businessIdentificationType and businessIdentificationValue are provided. | [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/TmsBusinessInformationAddress.md b/docs/TmsBusinessInformationAddress.md deleted file mode 100644 index 0f9b13dc..00000000 --- a/docs/TmsBusinessInformationAddress.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsBusinessInformationAddress - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**country** | **str** | Country of network token merchant. | [optional] -**locality** | **str** | City of network token merchant. | [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/TmsCardArt.md b/docs/TmsCardArt.md deleted file mode 100644 index ec919d38..00000000 --- a/docs/TmsCardArt.md +++ /dev/null @@ -1,14 +0,0 @@ -# TmsCardArt - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**foreground_color** | **str** | Card foreground color. | [optional] -**combined_asset** | [**TmsCardArtCombinedAsset**](TmsCardArtCombinedAsset.md) | | [optional] -**brand_logo_asset** | [**TmsCardArtBrandLogoAsset**](TmsCardArtBrandLogoAsset.md) | | [optional] -**issuer_logo_asset** | [**TmsCardArtIssuerLogoAsset**](TmsCardArtIssuerLogoAsset.md) | | [optional] -**icon_asset** | [**TmsCardArtIconAsset**](TmsCardArtIconAsset.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/TmsCardArtBrandLogoAsset.md b/docs/TmsCardArtBrandLogoAsset.md deleted file mode 100644 index a51ed7c0..00000000 --- a/docs/TmsCardArtBrandLogoAsset.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsCardArtBrandLogoAsset - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the asset | [optional] -**links** | [**TmsCardArtBrandLogoAssetLinks**](TmsCardArtBrandLogoAssetLinks.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/TmsCardArtBrandLogoAssetLinks.md b/docs/TmsCardArtBrandLogoAssetLinks.md deleted file mode 100644 index bace1a5e..00000000 --- a/docs/TmsCardArtBrandLogoAssetLinks.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsCardArtBrandLogoAssetLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**TmsCardArtBrandLogoAssetLinksSelf**](TmsCardArtBrandLogoAssetLinksSelf.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/TmsCardArtBrandLogoAssetLinksSelf.md b/docs/TmsCardArtBrandLogoAssetLinksSelf.md deleted file mode 100644 index 4b5b348d..00000000 --- a/docs/TmsCardArtBrandLogoAssetLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsCardArtBrandLogoAssetLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo' | [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/TmsCardArtCombinedAsset.md b/docs/TmsCardArtCombinedAsset.md deleted file mode 100644 index 54f25659..00000000 --- a/docs/TmsCardArtCombinedAsset.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsCardArtCombinedAsset - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the asset | [optional] -**links** | [**TmsCardArtCombinedAssetLinks**](TmsCardArtCombinedAssetLinks.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/TmsCardArtCombinedAssetLinks.md b/docs/TmsCardArtCombinedAssetLinks.md deleted file mode 100644 index ea9fe52a..00000000 --- a/docs/TmsCardArtCombinedAssetLinks.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsCardArtCombinedAssetLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**TmsCardArtCombinedAssetLinksSelf**](TmsCardArtCombinedAssetLinksSelf.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/TmsCardArtCombinedAssetLinksSelf.md b/docs/TmsCardArtCombinedAssetLinksSelf.md deleted file mode 100644 index 46abe373..00000000 --- a/docs/TmsCardArtCombinedAssetLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsCardArtCombinedAssetLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined' | [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/TmsCardArtIconAsset.md b/docs/TmsCardArtIconAsset.md deleted file mode 100644 index 574d1449..00000000 --- a/docs/TmsCardArtIconAsset.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsCardArtIconAsset - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the asset | [optional] -**links** | [**TmsCardArtIconAssetLinks**](TmsCardArtIconAssetLinks.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/TmsCardArtIconAssetLinks.md b/docs/TmsCardArtIconAssetLinks.md deleted file mode 100644 index f8b8d59b..00000000 --- a/docs/TmsCardArtIconAssetLinks.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsCardArtIconAssetLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**TmsCardArtIconAssetLinksSelf**](TmsCardArtIconAssetLinksSelf.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/TmsCardArtIconAssetLinksSelf.md b/docs/TmsCardArtIconAssetLinksSelf.md deleted file mode 100644 index 6074bef4..00000000 --- a/docs/TmsCardArtIconAssetLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsCardArtIconAssetLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/icon' | [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/TmsCardArtIssuerLogoAsset.md b/docs/TmsCardArtIssuerLogoAsset.md deleted file mode 100644 index 2394b6f5..00000000 --- a/docs/TmsCardArtIssuerLogoAsset.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsCardArtIssuerLogoAsset - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the asset | [optional] -**links** | [**TmsCardArtIssuerLogoAssetLinks**](TmsCardArtIssuerLogoAssetLinks.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/TmsCardArtIssuerLogoAssetLinks.md b/docs/TmsCardArtIssuerLogoAssetLinks.md deleted file mode 100644 index 7e91b4c6..00000000 --- a/docs/TmsCardArtIssuerLogoAssetLinks.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsCardArtIssuerLogoAssetLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**TmsCardArtIssuerLogoAssetLinksSelf**](TmsCardArtIssuerLogoAssetLinksSelf.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/TmsCardArtIssuerLogoAssetLinksSelf.md b/docs/TmsCardArtIssuerLogoAssetLinksSelf.md deleted file mode 100644 index 84781f5b..00000000 --- a/docs/TmsCardArtIssuerLogoAssetLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsCardArtIssuerLogoAssetLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo' | [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/TmsEmbeddedInstrumentIdentifier.md b/docs/TmsEmbeddedInstrumentIdentifier.md deleted file mode 100644 index 467e2c40..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifier.md +++ /dev/null @@ -1,23 +0,0 @@ -# TmsEmbeddedInstrumentIdentifier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**TmsEmbeddedInstrumentIdentifierLinks**](TmsEmbeddedInstrumentIdentifierLinks.md) | | [optional] -**id** | **str** | The Id of the Instrument Identifier Token. | [optional] -**object** | **str** | The type. Possible Values: - instrumentIdentifier | [optional] -**state** | **str** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] -**type** | **str** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] -**token_provisioning_information** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] -**card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] -**bank_account** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] -**tokenized_card** | [**Tmsv2TokenizedCard**](Tmsv2TokenizedCard.md) | | [optional] -**issuer** | [**TmsEmbeddedInstrumentIdentifierIssuer**](TmsEmbeddedInstrumentIdentifierIssuer.md) | | [optional] -**processing_information** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional] -**bill_to** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional] -**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional] -**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.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/TmsEmbeddedInstrumentIdentifierBankAccount.md b/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md deleted file mode 100644 index e7fe977a..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierBankAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **str** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] -**routing_number** | **str** | 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] - -[[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/TmsEmbeddedInstrumentIdentifierBillTo.md b/docs/TmsEmbeddedInstrumentIdentifierBillTo.md deleted file mode 100644 index 2bec3541..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierBillTo.md +++ /dev/null @@ -1,15 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] -**address2** | **str** | Additional address information. | [optional] -**locality** | **str** | Payment card billing city. | [optional] -**administrative_area** | **str** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**postal_code** | **str** | 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` | [optional] -**country** | **str** | Payment card billing country. Use the two-character ISO Standard Country Codes. | [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/TmsEmbeddedInstrumentIdentifierCard.md b/docs/TmsEmbeddedInstrumentIdentifierCard.md deleted file mode 100644 index 2b9b66aa..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierCard.md +++ /dev/null @@ -1,13 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. | [optional] -**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] -**expiration_year** | **str** | Four-digit year in which the credit card expires. Format: `YYYY`. | [optional] -**security_code** | **str** | Card Verification Code. This value is sent to the issuer to support the approval of a network token provision. It is not persisted against the Instrument Identifier. | [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/TmsEmbeddedInstrumentIdentifierEmbedded.md b/docs/TmsEmbeddedInstrumentIdentifierEmbedded.md deleted file mode 100644 index a93e3eb4..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierEmbedded.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierEmbedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bin_lookup** | [**TmsBinLookup**](TmsBinLookup.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/TmsEmbeddedInstrumentIdentifierIssuer.md b/docs/TmsEmbeddedInstrumentIdentifierIssuer.md deleted file mode 100644 index 645e5b78..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierIssuer.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierIssuer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_account_reference** | **str** | This reference number serves as a link to the cardholder account and to all transactions for that 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/TmsEmbeddedInstrumentIdentifierLinks.md b/docs/TmsEmbeddedInstrumentIdentifierLinks.md deleted file mode 100644 index 0a9d3dd1..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierLinks.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**TmsEmbeddedInstrumentIdentifierLinksSelf**](TmsEmbeddedInstrumentIdentifierLinksSelf.md) | | [optional] -**payment_instruments** | [**TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments**](TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.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/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.md b/docs/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.md deleted file mode 100644 index 67ffa7e3..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Instrument Identifiers Payment Instruments. | [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/TmsEmbeddedInstrumentIdentifierLinksSelf.md b/docs/TmsEmbeddedInstrumentIdentifierLinksSelf.md deleted file mode 100644 index da1ceeb9..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Instrument Identifier. | [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/TmsEmbeddedInstrumentIdentifierMetadata.md b/docs/TmsEmbeddedInstrumentIdentifierMetadata.md deleted file mode 100644 index 3da96b5b..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierMetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creator** | **str** | The creator of the Instrument Identifier. | [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/TmsEmbeddedInstrumentIdentifierProcessingInformation.md b/docs/TmsEmbeddedInstrumentIdentifierProcessingInformation.md deleted file mode 100644 index 90317def..00000000 --- a/docs/TmsEmbeddedInstrumentIdentifierProcessingInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsEmbeddedInstrumentIdentifierProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**authorization_options** | [**TmsAuthorizationOptions**](TmsAuthorizationOptions.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/TmsNetworkTokenServices.md b/docs/TmsNetworkTokenServices.md deleted file mode 100644 index 6bb9e335..00000000 --- a/docs/TmsNetworkTokenServices.md +++ /dev/null @@ -1,15 +0,0 @@ -# TmsNetworkTokenServices - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**notifications** | [**TmsNetworkTokenServicesNotifications**](TmsNetworkTokenServicesNotifications.md) | | [optional] -**payment_credentials** | [**TmsNetworkTokenServicesPaymentCredentials**](TmsNetworkTokenServicesPaymentCredentials.md) | | [optional] -**synchronous_provisioning** | [**TmsNetworkTokenServicesSynchronousProvisioning**](TmsNetworkTokenServicesSynchronousProvisioning.md) | | [optional] -**visa_token_service** | [**TmsNetworkTokenServicesVisaTokenService**](TmsNetworkTokenServicesVisaTokenService.md) | | [optional] -**mastercard_digital_enablement_service** | [**TmsNetworkTokenServicesMastercardDigitalEnablementService**](TmsNetworkTokenServicesMastercardDigitalEnablementService.md) | | [optional] -**american_express_token_service** | [**TmsNetworkTokenServicesAmericanExpressTokenService**](TmsNetworkTokenServicesAmericanExpressTokenService.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/TmsNetworkTokenServicesAmericanExpressTokenService.md b/docs/TmsNetworkTokenServicesAmericanExpressTokenService.md deleted file mode 100644 index 0536c0c7..00000000 --- a/docs/TmsNetworkTokenServicesAmericanExpressTokenService.md +++ /dev/null @@ -1,13 +0,0 @@ -# TmsNetworkTokenServicesAmericanExpressTokenService - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enable_service** | **bool** | Indicates if the service for network tokens for the American Express card association are enabled | [optional] -**enable_transactional_tokens** | **bool** | Indicates if network tokens for the American Express card association are enabled for transactions | [optional] -**token_requestor_id** | **str** | Token Requestor ID provided by American Express during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"12345678912\" | [optional] -**se_number** | **str** | SE Number assigned by American Express for the merchant's account Pattern: \"^[0-9]{11}\\\\z$\" Min Length: 10 Max Length: 10 Example: \"9876543212\" | [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/TmsNetworkTokenServicesMastercardDigitalEnablementService.md b/docs/TmsNetworkTokenServicesMastercardDigitalEnablementService.md deleted file mode 100644 index 8b4bb806..00000000 --- a/docs/TmsNetworkTokenServicesMastercardDigitalEnablementService.md +++ /dev/null @@ -1,12 +0,0 @@ -# TmsNetworkTokenServicesMastercardDigitalEnablementService - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enable_service** | **bool** | Indicates if the service for network tokens for the Mastercard card association are enabled | [optional] -**enable_transactional_tokens** | **bool** | Indicates if network tokens for the Mastercard card association are enabled for transactions | [optional] -**token_requestor_id** | **str** | Token Requestor ID provided by Mastercard during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"50162233570\" | [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/TmsNetworkTokenServicesNotifications.md b/docs/TmsNetworkTokenServicesNotifications.md deleted file mode 100644 index 7e5818a6..00000000 --- a/docs/TmsNetworkTokenServicesNotifications.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsNetworkTokenServicesNotifications - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Indicates if lifecycle management (LCM) notifications are enabled | [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/TmsNetworkTokenServicesPaymentCredentials.md b/docs/TmsNetworkTokenServicesPaymentCredentials.md deleted file mode 100644 index d739ffdd..00000000 --- a/docs/TmsNetworkTokenServicesPaymentCredentials.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsNetworkTokenServicesPaymentCredentials - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Indicates if Payment Credentials are enabled. If enabled, this provides access to the unredacted token and its associated cryptogram. | [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/TmsNetworkTokenServicesSynchronousProvisioning.md b/docs/TmsNetworkTokenServicesSynchronousProvisioning.md deleted file mode 100644 index b5a07b45..00000000 --- a/docs/TmsNetworkTokenServicesSynchronousProvisioning.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsNetworkTokenServicesSynchronousProvisioning - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Indicates if network tokens are provisioned synchronously (i.e. as part of the transaction flow) or asychronously (i.e. in parallel to the payment flow) NOTE: The synchronous provisioning feature is designed exclusively for aggregator merchants. Direct merchants should not enable synchronous provisioning as TMS manages the asynchronous creation of network tokens for direct clients. Activation of this feature by direct merchants will lead to latency in the authorization response. | [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/TmsNetworkTokenServicesVisaTokenService.md b/docs/TmsNetworkTokenServicesVisaTokenService.md deleted file mode 100644 index 7e2f5617..00000000 --- a/docs/TmsNetworkTokenServicesVisaTokenService.md +++ /dev/null @@ -1,13 +0,0 @@ -# TmsNetworkTokenServicesVisaTokenService - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enable_service** | **bool** | Indicates if the service for network tokens for the Visa card association are enabled | [optional] -**enable_transactional_tokens** | **bool** | Indicates if network tokens for the Visa card association are enabled for transactions | [optional] -**token_requestor_id** | **str** | Token Requestor ID provided by Visa during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"40000000082\" | [optional] -**relationship_id** | **str** | Relationship ID provided by visa Min Length: 1 Max Length: 100 Example: \"24681921-40000000082\" | [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/TmsNullify.md b/docs/TmsNullify.md deleted file mode 100644 index 3ed9c0e1..00000000 --- a/docs/TmsNullify.md +++ /dev/null @@ -1,12 +0,0 @@ -# TmsNullify - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**instrument_identifier_card_number** | **bool** | Indicates if the card number should be nullified (i.e. not stored) | [optional] -**instrument_identifier_card_expiration** | **bool** | Indicates if the expiration date associated to the instrument identifier should be nullified (i.e. not stored) | [optional] -**payment_instrument_card_details** | **bool** | Indicates if the card details should be nullified (i.e. not stored) | [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/TmsPaymentInstrumentProcessingInfo.md b/docs/TmsPaymentInstrumentProcessingInfo.md deleted file mode 100644 index 9d46c80e..00000000 --- a/docs/TmsPaymentInstrumentProcessingInfo.md +++ /dev/null @@ -1,11 +0,0 @@ -# TmsPaymentInstrumentProcessingInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bill_payment_program_enabled** | **bool** | Flag that indicates that this is a payment for a bill or for an existing contractual loan. Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. # For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**bank_transfer_options** | [**TmsPaymentInstrumentProcessingInfoBankTransferOptions**](TmsPaymentInstrumentProcessingInfoBankTransferOptions.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/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md b/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md deleted file mode 100644 index a4d6e39b..00000000 --- a/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsPaymentInstrumentProcessingInfoBankTransferOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sec_code** | **str** | Specifies the authorization method for the transaction. #### TeleCheck Possible Values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry # For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] - -[[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/TmsSensitivePrivileges.md b/docs/TmsSensitivePrivileges.md deleted file mode 100644 index 0e2e8f5e..00000000 --- a/docs/TmsSensitivePrivileges.md +++ /dev/null @@ -1,10 +0,0 @@ -# TmsSensitivePrivileges - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card_number_masking_format** | **str** | Indicates which digits of the card number will be unmasked. Possible Values: - 'FIRST_6_LAST_4' - 'LAST_4' - 'MASKED' | [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/TmsTokenFormats.md b/docs/TmsTokenFormats.md deleted file mode 100644 index 2108f8db..00000000 --- a/docs/TmsTokenFormats.md +++ /dev/null @@ -1,13 +0,0 @@ -# TmsTokenFormats - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer** | **str** | Format for customer tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [optional] -**payment_instrument** | **str** | Format for payment instrument tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [optional] -**instrument_identifier_card** | **str** | Format for card based instrument identifier tokens. Possible Values: - '16_DIGIT' - '16_DIGIT_LAST_4' - '19_DIGIT' - '19_DIGIT_LAST_4' - '22_DIGIT' - '32_HEX' | [optional] -**instrument_identifier_bank_account** | **str** | Format for bank account based instrument identifier tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [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/Tmsv2TokenizedCard.md b/docs/Tmsv2TokenizedCard.md deleted file mode 100644 index 34ddbd90..00000000 --- a/docs/Tmsv2TokenizedCard.md +++ /dev/null @@ -1,32 +0,0 @@ -# Tmsv2TokenizedCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv2TokenizedCardLinks**](Tmsv2TokenizedCardLinks.md) | | [optional] -**id** | **str** | The Id of the Tokenized Card. | [optional] -**object** | **str** | The type. Possible Values: - tokenizedCard | [optional] -**account_reference_id** | **str** | An identifier provided by the issuer for the account. | [optional] -**consumer_id** | **str** | Identifier of the consumer within the wallet. Maximum 24 characters for VTS. | [optional] -**create_instrument_identifier** | **bool** | Specifies whether the InstrumentId should be created (true) or not (false). Possible Values: - `true`: The InstrumentId should be created. - `false`: The InstrumentId should be created. | [optional] -**source** | **str** | Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER | [optional] -**state** | **str** | State of the network token or network token provision. Possible Values: ACTIVE : Network token is active. SUSPENDED : Network token is suspended. This state can change back to ACTIVE. DELETED : This is a final state for a network token instance. UNPROVISIONED : A previous network token. | [optional] -**reason** | **str** | Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration. | [optional] -**number** | **str** | The token requestor's network token for the provided PAN and consumer Id, if available. | [optional] -**expiration_month** | **str** | Two-digit month in which the network token expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] -**expiration_year** | **str** | Four-digit year in which the network token expires. Format: `YYYY`. | [optional] -**type** | **str** | The type of card (Card Network). Possible Values: - visa - mastercard - americanexpress | [optional] -**cryptogram** | **str** | Value generated by the card association to be used alongside the network token for processing a payment. | [optional] -**security_code** | **str** | 4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF. | [optional] -**eci** | **str** | Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication. | [optional] -**requestor_id** | **str** | 11-digit identifier that uniquely identifies the Token Requestor. | [optional] -**enrollment_id** | **str** | Unique id to identify this PAN/ enrollment. | [optional] -**token_reference_id** | **str** | Unique ID for netwrok token. | [optional] -**payment_account_reference** | **str** | Payment account reference. | [optional] -**card** | [**Tmsv2TokenizedCardCard**](Tmsv2TokenizedCardCard.md) | | [optional] -**passcode** | [**Tmsv2TokenizedCardPasscode**](Tmsv2TokenizedCardPasscode.md) | | [optional] -**metadata** | [**Tmsv2TokenizedCardMetadata**](Tmsv2TokenizedCardMetadata.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/Tmsv2TokenizedCardCard.md b/docs/Tmsv2TokenizedCardCard.md deleted file mode 100644 index 58d0875a..00000000 --- a/docs/Tmsv2TokenizedCardCard.md +++ /dev/null @@ -1,14 +0,0 @@ -# Tmsv2TokenizedCardCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). | [optional] -**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] -**expiration_year** | **str** | Four-digit year in which the credit card expires. Format: `YYYY`. | [optional] -**type** | **str** | The type of card (Card Network). Possible Values: - 001: visa | [optional] -**suffix** | **str** | The customer's latest payment card number suffix. | [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/Tmsv2TokenizedCardLinks.md b/docs/Tmsv2TokenizedCardLinks.md deleted file mode 100644 index 06498123..00000000 --- a/docs/Tmsv2TokenizedCardLinks.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2TokenizedCardLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**Tmsv2TokenizedCardLinksSelf**](Tmsv2TokenizedCardLinksSelf.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/Tmsv2TokenizedCardLinksSelf.md b/docs/Tmsv2TokenizedCardLinksSelf.md deleted file mode 100644 index 54bcc484..00000000 --- a/docs/Tmsv2TokenizedCardLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2TokenizedCardLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Tokenized Card. example: 'tms/v2/tokenized-cards/7010000000016241111' | [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/Tmsv2TokenizedCardMetadata.md b/docs/Tmsv2TokenizedCardMetadata.md deleted file mode 100644 index b39ac97a..00000000 --- a/docs/Tmsv2TokenizedCardMetadata.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2TokenizedCardMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card_art** | [**TmsCardArt**](TmsCardArt.md) | | [optional] -**issuer** | [**Tmsv2TokenizedCardMetadataIssuer**](Tmsv2TokenizedCardMetadataIssuer.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/Tmsv2TokenizedCardMetadataIssuer.md b/docs/Tmsv2TokenizedCardMetadataIssuer.md deleted file mode 100644 index 687de185..00000000 --- a/docs/Tmsv2TokenizedCardMetadataIssuer.md +++ /dev/null @@ -1,12 +0,0 @@ -# Tmsv2TokenizedCardMetadataIssuer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | issuer name. | [optional] -**short_description** | **str** | issuer short description. | [optional] -**long_description** | **str** | issuer long description. | [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/Tmsv2TokenizedCardPasscode.md b/docs/Tmsv2TokenizedCardPasscode.md deleted file mode 100644 index de179909..00000000 --- a/docs/Tmsv2TokenizedCardPasscode.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2TokenizedCardPasscode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | **str** | OTP generated at issuer. | [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/Tmsv2customersBuyerInformation.md b/docs/Tmsv2customersBuyerInformation.md deleted file mode 100644 index cf57c3da..00000000 --- a/docs/Tmsv2customersBuyerInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_customer_id** | **str** | Your identifier for the customer. | [optional] -**email** | **str** | Customer's primary email address, including the full domain name. | [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/Tmsv2customersClientReferenceInformation.md b/docs/Tmsv2customersClientReferenceInformation.md deleted file mode 100644 index 7290a585..00000000 --- a/docs/Tmsv2customersClientReferenceInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Client-generated order reference or tracking number. | [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/Tmsv2customersDefaultPaymentInstrument.md b/docs/Tmsv2customersDefaultPaymentInstrument.md deleted file mode 100644 index 961de0cc..00000000 --- a/docs/Tmsv2customersDefaultPaymentInstrument.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersDefaultPaymentInstrument - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | The Id of the Customers default Payment Instrument | [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/Tmsv2customersDefaultShippingAddress.md b/docs/Tmsv2customersDefaultShippingAddress.md deleted file mode 100644 index ed713253..00000000 --- a/docs/Tmsv2customersDefaultShippingAddress.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersDefaultShippingAddress - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | The Id of the Customers default Shipping 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/Tmsv2customersEmbedded.md b/docs/Tmsv2customersEmbedded.md deleted file mode 100644 index fbea8aa1..00000000 --- a/docs/Tmsv2customersEmbedded.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersEmbedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**default_payment_instrument** | [**Tmsv2customersEmbeddedDefaultPaymentInstrument**](Tmsv2customersEmbeddedDefaultPaymentInstrument.md) | | [optional] -**default_shipping_address** | [**Tmsv2customersEmbeddedDefaultShippingAddress**](Tmsv2customersEmbeddedDefaultShippingAddress.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/Tmsv2customersEmbeddedDefaultPaymentInstrument.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrument.md deleted file mode 100644 index 5c103fbc..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrument.md +++ /dev/null @@ -1,24 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrument - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] -**id** | **str** | The Id of the Payment Instrument Token. | [optional] -**object** | **str** | The type. Possible Values: - paymentInstrument | [optional] -**default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] -**state** | **str** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] -**type** | **str** | The type of Payment Instrument. Possible Values: - cardHash | [optional] -**bank_account** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] -**card** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] -**buyer_information** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] -**bill_to** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] -**processing_information** | [**TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] -**merchant_information** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md) | | [optional] -**instrument_identifier** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] -**metadata** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] -**embedded** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md deleted file mode 100644 index 439773fd..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | Account type. Possible Values: - checking : C - general ledger : G This value is supported only on Wells Fargo ACH - savings : S (U.S. dollars only) - corporate checking : X (U.S. dollars 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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md deleted file mode 100644 index a3bc5fcb..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md +++ /dev/null @@ -1,20 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**first_name** | **str** | Customer's first name. This name must be the same as the name on the card. | [optional] -**last_name** | **str** | Customer's last name. This name must be the same as the name on the card. | [optional] -**company** | **str** | Name of the customer's company. | [optional] -**address1** | **str** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] -**address2** | **str** | Additional address information. | [optional] -**locality** | **str** | Payment card billing city. | [optional] -**administrative_area** | **str** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**postal_code** | **str** | 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` | [optional] -**country** | **str** | Payment card billing country. Use the two-character ISO Standard Country Codes. | [optional] -**email** | **str** | Customer's email address, including the full domain name. | [optional] -**phone_number** | **str** | Customer's phone number. | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md deleted file mode 100644 index cad284d8..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**company_tax_id** | **str** | Company's tax identifier. This is only used for eCheck service. | [optional] -**currency** | **str** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). # For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**date_of_birth** | **date** | Date of birth of the customer. Format: YYYY-MM-DD | [optional] -**personal_identification** | [**list[Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification]**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md deleted file mode 100644 index b064e509..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**administrative_area** | **str** | The State or province where the customer's driver's license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada. | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md deleted file mode 100644 index 25a33702..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md +++ /dev/null @@ -1,12 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | The value of the identification type. | [optional] -**type** | **str** | The type of the identification. Possible Values: - driver license | [optional] -**issued_by** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md deleted file mode 100644 index 1a0e3228..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md +++ /dev/null @@ -1,18 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] -**expiration_year** | **str** | Four-digit year in which the credit card expires. Format: `YYYY`. | [optional] -**type** | **str** | Value that indicates the card type. Possible Values v2 : v1: * 001 : visa * 002 : mastercard - Eurocard—European regional brand of Mastercard * 003 : american express * 004 : discover * 005 : diners club * 006 : carte blanche * 007 : jcb * 008 : optima * 011 : twinpay credit * 012 : twinpay debit * 013 : walmart * 014 : enRoute * 015 : lowes consumer * 016 : home depot consumer * 017 : mbna * 018 : dicks sportswear * 019 : casual corner * 020 : sears * 021 : jal * 023 : disney * 024 : maestro uk domestic * 025 : sams club consumer * 026 : sams club business * 028 : bill me later * 029 : bebe * 030 : restoration hardware * 031 : delta online — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * 032 : solo * 033 : visa electron * 034 : dankort * 035 : laser * 036 : carte bleue — formerly Cartes Bancaires * 037 : carta si * 038 : pinless debit * 039 : encoded account * 040 : uatp * 041 : household * 042 : maestro international * 043 : ge money uk * 044 : korean cards * 045 : style * 046 : jcrew * 047 : payease china processing ewallet * 048 : payease china processing bank transfer * 049 : meijer private label * 050 : hipercard — supported only by the Comercio Latino processor. * 051 : aura — supported only by the Comercio Latino processor. * 052 : redecard * 054 : elo — supported only by the Comercio Latino processor. * 055 : capital one private label * 056 : synchrony private label * 057 : costco private label * 060 : mada * 062 : china union pay * 063 : falabella private label | [optional] -**issue_number** | **str** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. | [optional] -**start_month** | **str** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible Values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] -**start_year** | **str** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] -**use_as** | **str** | 'Payment Instrument was created / updated as part of a pinless debit transaction.' | [optional] -**hash** | **str** | Hash value representing the card. | [optional] -**tokenized_information** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md deleted file mode 100644 index 74447adb..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**requestor_id** | **str** | Value that identifies your business and indicates that the cardholder's account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider's database. **Note** This field is supported only through **VisaNet** and **FDC Nashville Global**. | [optional] -**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Set the value for this field to 1. An application on the customer's mobile device provided the token data. | [optional] - -[[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/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md deleted file mode 100644 index 13368f03..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**instrument_identifier** | [**TmsEmbeddedInstrumentIdentifier**](TmsEmbeddedInstrumentIdentifier.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md deleted file mode 100644 index e1f8d02e..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | The Id of the Instrument Identifier linked to the Payment Instrument. | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md deleted file mode 100644 index 0c3ddad8..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md) | | [optional] -**customer** | [**Tmsv2customersLinksSelf**](Tmsv2customersLinksSelf.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md deleted file mode 100644 index 379168fe..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Payment Instrument. | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md deleted file mode 100644 index 0bf1a437..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_descriptor** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md deleted file mode 100644 index d03ed57c..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**alternate_name** | **str** | Alternate contact information for your business,such as an email address or URL. This value might be displayed on the cardholder's statement. When you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used. Important This value must consist of English characters | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md deleted file mode 100644 index 5c6f56de..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creator** | **str** | The creator of the Payment Instrument. | [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/Tmsv2customersEmbeddedDefaultShippingAddress.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddress.md deleted file mode 100644 index 35660580..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultShippingAddress.md +++ /dev/null @@ -1,14 +0,0 @@ -# Tmsv2customersEmbeddedDefaultShippingAddress - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv2customersEmbeddedDefaultShippingAddressLinks**](Tmsv2customersEmbeddedDefaultShippingAddressLinks.md) | | [optional] -**id** | **str** | The Id of the Shipping Address Token. | [optional] -**default** | **bool** | Flag that indicates whether customer shipping address is the dafault. Possible Values: - `true`: Shipping Address is customer's default. - `false`: Shipping Address is not customer's default. | [optional] -**ship_to** | [**Tmsv2customersEmbeddedDefaultShippingAddressShipTo**](Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md) | | [optional] -**metadata** | [**Tmsv2customersEmbeddedDefaultShippingAddressMetadata**](Tmsv2customersEmbeddedDefaultShippingAddressMetadata.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/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md deleted file mode 100644 index 905976a9..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf**](Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md) | | [optional] -**customer** | [**Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer**](Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.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/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md deleted file mode 100644 index c605d986..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Customer | [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/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md deleted file mode 100644 index 9cf612d4..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Customers Shipping 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/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md deleted file mode 100644 index 72151cf0..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creator** | **str** | The creator of the Shipping 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/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md deleted file mode 100644 index 639ccf44..00000000 --- a/docs/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md +++ /dev/null @@ -1,20 +0,0 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**first_name** | **str** | First name of the recipient. | [optional] -**last_name** | **str** | Last name of the recipient. | [optional] -**company** | **str** | Company associated with the shipping address. | [optional] -**address1** | **str** | First line of the shipping address. | [optional] -**address2** | **str** | Second line of the shipping address. | [optional] -**locality** | **str** | City of the shipping address. | [optional] -**administrative_area** | **str** | State or province of the shipping address. Use 2 character the State, Province, and Territory Codes for the United States and Canada. | [optional] -**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, truncates the value starting from the right side. | [optional] -**country** | **str** | Country of the shipping address. Use the two-character ISO Standard Country Codes. | [optional] -**email** | **str** | Email associated with the shipping address. | [optional] -**phone_number** | **str** | Phone number associated with the shipping 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/Tmsv2customersLinks.md b/docs/Tmsv2customersLinks.md deleted file mode 100644 index 00ceccbe..00000000 --- a/docs/Tmsv2customersLinks.md +++ /dev/null @@ -1,12 +0,0 @@ -# Tmsv2customersLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**Tmsv2customersLinksSelf**](Tmsv2customersLinksSelf.md) | | [optional] -**payment_instruments** | [**Tmsv2customersLinksPaymentInstruments**](Tmsv2customersLinksPaymentInstruments.md) | | [optional] -**shipping_address** | [**Tmsv2customersLinksShippingAddress**](Tmsv2customersLinksShippingAddress.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/Tmsv2customersLinksPaymentInstruments.md b/docs/Tmsv2customersLinksPaymentInstruments.md deleted file mode 100644 index 880618d7..00000000 --- a/docs/Tmsv2customersLinksPaymentInstruments.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersLinksPaymentInstruments - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Customers Payment Instruments. | [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/Tmsv2customersLinksSelf.md b/docs/Tmsv2customersLinksSelf.md deleted file mode 100644 index 5cf6c4f3..00000000 --- a/docs/Tmsv2customersLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Customer. | [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/Tmsv2customersLinksShippingAddress.md b/docs/Tmsv2customersLinksShippingAddress.md deleted file mode 100644 index 2281b09a..00000000 --- a/docs/Tmsv2customersLinksShippingAddress.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersLinksShippingAddress - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | Link to the Customers Shipping Addresses. | [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/Tmsv2customersMerchantDefinedInformation.md b/docs/Tmsv2customersMerchantDefinedInformation.md deleted file mode 100644 index 66e79196..00000000 --- a/docs/Tmsv2customersMerchantDefinedInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersMerchantDefinedInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The number you assign as the name for your merchant-defined data or secure field. Possible Values are data1 to data4 and sensitive1 to sensitive4 For example, to set the name for merchant-defined data 2 field, you would reference merchantDefinedInformation[x].name as data2 Possible Values: - data1 - data2 - data3 - data4 - sensitive1 - sensitive2 - sensitive3 - sensitive4 | [optional] -**value** | **str** | 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 it is discovered a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account will immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. | [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/Tmsv2customersMetadata.md b/docs/Tmsv2customersMetadata.md deleted file mode 100644 index 6dbd74da..00000000 --- a/docs/Tmsv2customersMetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creator** | **str** | The creator of the Customer. | [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/Tmsv2customersObjectInformation.md b/docs/Tmsv2customersObjectInformation.md deleted file mode 100644 index ec708b25..00000000 --- a/docs/Tmsv2customersObjectInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersObjectInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**title** | **str** | Name or title of the customer. | [optional] -**comment** | **str** | Comments that you can make about the customer. | [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/TokenApi.md b/docs/TokenApi.md deleted file mode 100644 index d334c50b..00000000 --- a/docs/TokenApi.md +++ /dev/null @@ -1,114 +0,0 @@ -# CyberSource.TokenApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_card_art_asset**](TokenApi.md#get_card_art_asset) | **GET** /tms/v2/tokens/{instrumentIdentifierId}/{tokenProvider}/assets/{assetType} | Retrieve Card Art -[**post_token_payment_credentials**](TokenApi.md#post_token_payment_credentials) | **POST** /tms/v2/tokens/{tokenId}/payment-credentials | Generate Payment Credentials for a TMS Token - - -# **get_card_art_asset** -> InlineResponse200 get_card_art_asset(instrument_identifier_id, token_provider, asset_type) - -Retrieve Card Art - -Retrieves Card Art for a specific Instrument Identifier. The Card Art is a visual representation of the cardholder's payment card. Card Art is only available if a Network Token is successfully provisioned. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TokenApi() -instrument_identifier_id = 'instrument_identifier_id_example' # str | The Id of an Instrument Identifier. -token_provider = 'token_provider_example' # str | The token provider. -asset_type = 'asset_type_example' # str | The type of asset. - -try: - # Retrieve Card Art - api_response = api_instance.get_card_art_asset(instrument_identifier_id, token_provider, asset_type) - pprint(api_response) -except ApiException as e: - print("Exception when calling TokenApi->get_card_art_asset: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instrument_identifier_id** | **str**| The Id of an Instrument Identifier. | - **token_provider** | **str**| The token provider. | - **asset_type** | **str**| The type of asset. | - -### Return type - -[**InlineResponse200**](InlineResponse200.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **post_token_payment_credentials** -> str post_token_payment_credentials(token_id, post_payment_credentials_request, profile_id=profile_id) - -Generate Payment Credentials for a TMS Token - -| | | | | --- | --- | --- | |**Token**
A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|      |**Payment Credentials**
Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.
Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TokenApi() -token_id = 'token_id_example' # str | The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. -post_payment_credentials_request = CyberSource.PostPaymentCredentialsRequest() # PostPaymentCredentialsRequest | -profile_id = 'profile_id_example' # str | The Id of a profile containing user specific TMS configuration. (optional) - -try: - # Generate Payment Credentials for a TMS Token - api_response = api_instance.post_token_payment_credentials(token_id, post_payment_credentials_request, profile_id=profile_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling TokenApi->post_token_payment_credentials: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token_id** | **str**| The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. | - **post_payment_credentials_request** | [**PostPaymentCredentialsRequest**](PostPaymentCredentialsRequest.md)| | - **profile_id** | **str**| The Id of a profile containing user specific TMS configuration. | [optional] - -### Return type - -**str** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/jose;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TokenPermissions.md b/docs/TokenPermissions.md deleted file mode 100644 index 1956c5fd..00000000 --- a/docs/TokenPermissions.md +++ /dev/null @@ -1,13 +0,0 @@ -# TokenPermissions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**create** | **bool** | Indicates if tokens may be created | [optional] -**read** | **bool** | Indicates if tokens may be read | [optional] -**update** | **bool** | Indicates if tokens may be updated | [optional] -**delete** | **bool** | Indicates if tokens may be deleted | [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/TokenizedCardApi.md b/docs/TokenizedCardApi.md deleted file mode 100644 index 42613005..00000000 --- a/docs/TokenizedCardApi.md +++ /dev/null @@ -1,160 +0,0 @@ -# CyberSource.TokenizedCardApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_tokenized_card**](TokenizedCardApi.md#delete_tokenized_card) | **DELETE** /tms/v2/tokenized-cards/{tokenizedCardId} | Delete a Tokenized Card -[**get_tokenized_card**](TokenizedCardApi.md#get_tokenized_card) | **GET** /tms/v2/tokenized-cards/{tokenizedCardId} | Retrieve a Tokenized Card -[**post_tokenized_card**](TokenizedCardApi.md#post_tokenized_card) | **POST** /tms/v2/tokenized-cards | Create a Tokenized Card - - -# **delete_tokenized_card** -> delete_tokenized_card(tokenized_card_id, profile_id=profile_id) - -Delete a Tokenized Card - -| | | | | --- | --- | --- | | The Network Token will attempt to be deleted from the card association and if successful the corresponding TMS Network Token will be deleted. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TokenizedCardApi() -tokenized_card_id = 'tokenized_card_id_example' # str | The Id of a tokenized card. -profile_id = 'profile_id_example' # str | The Id of a profile containing user specific TMS configuration. (optional) - -try: - # Delete a Tokenized Card - api_instance.delete_tokenized_card(tokenized_card_id, profile_id=profile_id) -except ApiException as e: - print("Exception when calling TokenizedCardApi->delete_tokenized_card: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tokenized_card_id** | **str**| The Id of a tokenized card. | - **profile_id** | **str**| The Id of a profile containing user specific TMS configuration. | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_tokenized_card** -> TokenizedcardRequest get_tokenized_card(tokenized_card_id, profile_id=profile_id) - -Retrieve a Tokenized Card - -| | | | | --- | --- | --- | |**Tokenized Cards**
A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TokenizedCardApi() -tokenized_card_id = 'tokenized_card_id_example' # str | The Id of a tokenized card. -profile_id = 'profile_id_example' # str | The Id of a profile containing user specific TMS configuration. (optional) - -try: - # Retrieve a Tokenized Card - api_response = api_instance.get_tokenized_card(tokenized_card_id, profile_id=profile_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling TokenizedCardApi->get_tokenized_card: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tokenized_card_id** | **str**| The Id of a tokenized card. | - **profile_id** | **str**| The Id of a profile containing user specific TMS configuration. | [optional] - -### Return type - -[**TokenizedcardRequest**](TokenizedcardRequest.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **post_tokenized_card** -> TokenizedcardRequest post_tokenized_card(tokenizedcard_request, profile_id=profile_id) - -Create a Tokenized Card - -| | | | | --- | --- | --- | |**Tokenized cards**
A Tokenized card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TokenizedCardApi() -tokenizedcard_request = CyberSource.TokenizedcardRequest() # TokenizedcardRequest | -profile_id = 'profile_id_example' # str | The Id of a profile containing user specific TMS configuration. (optional) - -try: - # Create a Tokenized Card - api_response = api_instance.post_tokenized_card(tokenizedcard_request, profile_id=profile_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling TokenizedCardApi->post_tokenized_card: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tokenizedcard_request** | [**TokenizedcardRequest**](TokenizedcardRequest.md)| | - **profile_id** | **str**| The Id of a profile containing user specific TMS configuration. | [optional] - -### Return type - -[**TokenizedcardRequest**](TokenizedcardRequest.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TokenizedcardRequest.md b/docs/TokenizedcardRequest.md deleted file mode 100644 index 22ae8724..00000000 --- a/docs/TokenizedcardRequest.md +++ /dev/null @@ -1,32 +0,0 @@ -# TokenizedcardRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv2TokenizedCardLinks**](Tmsv2TokenizedCardLinks.md) | | [optional] -**id** | **str** | The Id of the Tokenized Card. | [optional] -**object** | **str** | The type. Possible Values: - tokenizedCard | [optional] -**account_reference_id** | **str** | An identifier provided by the issuer for the account. | [optional] -**consumer_id** | **str** | Identifier of the consumer within the wallet. Maximum 24 characters for VTS. | [optional] -**create_instrument_identifier** | **bool** | Specifies whether the InstrumentId should be created (true) or not (false). Possible Values: - `true`: The InstrumentId should be created. - `false`: The InstrumentId should be created. | [optional] -**source** | **str** | Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER | [optional] -**state** | **str** | State of the network token or network token provision. Possible Values: ACTIVE : Network token is active. SUSPENDED : Network token is suspended. This state can change back to ACTIVE. DELETED : This is a final state for a network token instance. UNPROVISIONED : A previous network token. | [optional] -**reason** | **str** | Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration. | [optional] -**number** | **str** | The token requestor's network token for the provided PAN and consumer Id, if available. | [optional] -**expiration_month** | **str** | Two-digit month in which the network token expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] -**expiration_year** | **str** | Four-digit year in which the network token expires. Format: `YYYY`. | [optional] -**type** | **str** | The type of card (Card Network). Possible Values: - visa - mastercard - americanexpress | [optional] -**cryptogram** | **str** | Value generated by the card association to be used alongside the network token for processing a payment. | [optional] -**security_code** | **str** | 4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF. | [optional] -**eci** | **str** | Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication. | [optional] -**requestor_id** | **str** | 11-digit identifier that uniquely identifies the Token Requestor. | [optional] -**enrollment_id** | **str** | Unique id to identify this PAN/ enrollment. | [optional] -**token_reference_id** | **str** | Unique ID for netwrok token. | [optional] -**payment_account_reference** | **str** | Payment account reference. | [optional] -**card** | [**Tmsv2TokenizedCardCard**](Tmsv2TokenizedCardCard.md) | | [optional] -**passcode** | [**Tmsv2TokenizedCardPasscode**](Tmsv2TokenizedCardPasscode.md) | | [optional] -**metadata** | [**Tmsv2TokenizedCardMetadata**](Tmsv2TokenizedCardMetadata.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/TransactionBatchesApi.md b/docs/TransactionBatchesApi.md deleted file mode 100644 index 379a800b..00000000 --- a/docs/TransactionBatchesApi.md +++ /dev/null @@ -1,208 +0,0 @@ -# CyberSource.TransactionBatchesApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_transaction_batch_details**](TransactionBatchesApi.md#get_transaction_batch_details) | **GET** /pts/v1/transaction-batch-details/{id} | Get Transaction Details for a given Batch Id -[**get_transaction_batch_id**](TransactionBatchesApi.md#get_transaction_batch_id) | **GET** /pts/v1/transaction-batches/{id} | Get Individual Batch File -[**get_transaction_batches**](TransactionBatchesApi.md#get_transaction_batches) | **GET** /pts/v1/transaction-batches | Get a List of Batch Files -[**upload_transaction_batch**](TransactionBatchesApi.md#upload_transaction_batch) | **POST** /pts/v1/transaction-batch-upload | Upload a Batch File - - -# **get_transaction_batch_details** -> get_transaction_batch_details(id, upload_date=upload_date, status=status) - -Get Transaction Details for a given Batch Id - -Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TransactionBatchesApi() -id = 'id_example' # str | The batch id assigned for the template. -upload_date = '2013-10-20' # date | Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd (optional) -status = 'status_example' # str | Allows you to filter by rejected response. Valid values: - Rejected (optional) - -try: - # Get Transaction Details for a given Batch Id - api_instance.get_transaction_batch_details(id, upload_date=upload_date, status=status) -except ApiException as e: - print("Exception when calling TransactionBatchesApi->get_transaction_batch_details: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| The batch id assigned for the template. | - **upload_date** | **date**| Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd | [optional] - **status** | **str**| Allows you to filter by rejected response. Valid values: - Rejected | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: text/csv, application/xml, text/vnd.cybersource.map-csv - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_transaction_batch_id** -> PtsV1TransactionBatchesIdGet200Response get_transaction_batch_id(id) - -Get Individual Batch File - -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 -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TransactionBatchesApi() -id = 'id_example' # str | The batch id assigned for the template. - -try: - # Get Individual Batch File - api_response = api_instance.get_transaction_batch_id(id) - pprint(api_response) -except ApiException as e: - print("Exception when calling TransactionBatchesApi->get_transaction_batch_id: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| The batch id assigned for the template. | - -### Return type - -[**PtsV1TransactionBatchesIdGet200Response**](PtsV1TransactionBatchesIdGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_transaction_batches** -> PtsV1TransactionBatchesGet200Response get_transaction_batches(start_time, end_time) - -Get a List of Batch Files - -Provide the date and time search range to get a list of Batch Files ready for settlement - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TransactionBatchesApi() -start_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ -end_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ - -try: - # Get a List of Batch Files - api_response = api_instance.get_transaction_batches(start_time, end_time) - pprint(api_response) -except ApiException as e: - print("Exception when calling TransactionBatchesApi->get_transaction_batches: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_time** | **datetime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | - **end_time** | **datetime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | - -### Return type - -[**PtsV1TransactionBatchesGet200Response**](PtsV1TransactionBatchesGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_transaction_batch** -> upload_transaction_batch(file) - -Upload a Batch File - -This endpoint enables the upload of a batch file containing transactions for processing. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TransactionBatchesApi() -file = '/path/to/file.txt' # file | The file to upload. - -try: - # Upload a Batch File - api_instance.upload_transaction_batch(file) -except ApiException as e: - print("Exception when calling TransactionBatchesApi->upload_transaction_batch: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file** | **file**| The file to upload. | - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TransactionDetailsApi.md b/docs/TransactionDetailsApi.md deleted file mode 100644 index a6705efa..00000000 --- a/docs/TransactionDetailsApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# CyberSource.TransactionDetailsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_transaction**](TransactionDetailsApi.md#get_transaction) | **GET** /tss/v2/transactions/{id} | Retrieve a Transaction - - -# **get_transaction** -> TssV2TransactionsGet200Response get_transaction(id) - -Retrieve a Transaction - -Include the Request ID in the GET request to retrieve the transaction details. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TransactionDetailsApi() -id = 'id_example' # str | Request ID. - -try: - # Retrieve a Transaction - api_response = api_instance.get_transaction(id) - pprint(api_response) -except ApiException as e: - print("Exception when calling TransactionDetailsApi->get_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Request ID. | - -### Return type - -[**TssV2TransactionsGet200Response**](TssV2TransactionsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TransientTokenDataApi.md b/docs/TransientTokenDataApi.md deleted file mode 100644 index 547b305d..00000000 --- a/docs/TransientTokenDataApi.md +++ /dev/null @@ -1,105 +0,0 @@ -# CyberSource.TransientTokenDataApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_payment_credentials_for_transient_token**](TransientTokenDataApi.md#get_payment_credentials_for_transient_token) | **GET** /flex/v2/payment-credentials/{paymentCredentialsReference} | Get Payment Credentials -[**get_transaction_for_transient_token**](TransientTokenDataApi.md#get_transaction_for_transient_token) | **GET** /up/v1/payment-details/{transientToken} | Get Transient Token Data - - -# **get_payment_credentials_for_transient_token** -> str get_payment_credentials_for_transient_token(payment_credentials_reference) - -Get Payment Credentials - -Retrieve the Payment data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will return PCI payment data captured by the Unified Checkout platform. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TransientTokenDataApi() -payment_credentials_reference = 'payment_credentials_reference_example' # str | The paymentCredentialsReference field contained within the Transient token returned from a successful Unified Checkout transaction - -try: - # Get Payment Credentials - api_response = api_instance.get_payment_credentials_for_transient_token(payment_credentials_reference) - pprint(api_response) -except ApiException as e: - print("Exception when calling TransientTokenDataApi->get_payment_credentials_for_transient_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_credentials_reference** | **str**| The paymentCredentialsReference field contained within the Transient token returned from a successful Unified Checkout transaction | - -### Return type - -**str** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/jwt - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_transaction_for_transient_token** -> get_transaction_for_transient_token(transient_token) - -Get Transient Token Data - -Retrieve the data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will not return PCI payment data (PAN). Include the Request ID in the GET request to retrieve the transaction details. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.TransientTokenDataApi() -transient_token = 'transient_token_example' # str | Transient Token returned by the Unified Checkout application. - -try: - # Get Transient Token Data - api_instance.get_transaction_for_transient_token(transient_token) -except ApiException as e: - print("Exception when calling TransientTokenDataApi->get_transaction_for_transient_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transient_token** | **str**| Transient Token returned by the Unified Checkout application. | - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TssV2GetEmvTags200Response.md b/docs/TssV2GetEmvTags200Response.md deleted file mode 100644 index 40712805..00000000 --- a/docs/TssV2GetEmvTags200Response.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2GetEmvTags200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emv_tag_breakdown_list** | [**list[TssV2GetEmvTags200ResponseEmvTagBreakdownList]**](TssV2GetEmvTags200ResponseEmvTagBreakdownList.md) | An array of objects with each object containing a single EMV tag from the dictionary. | [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/TssV2GetEmvTags200ResponseEmvTagBreakdownList.md b/docs/TssV2GetEmvTags200ResponseEmvTagBreakdownList.md deleted file mode 100644 index 64543124..00000000 --- a/docs/TssV2GetEmvTags200ResponseEmvTagBreakdownList.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2GetEmvTags200ResponseEmvTagBreakdownList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tag** | **str** | Hexadecimal code of tag. | [optional] -**name** | **str** | Name of tag. | [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/TssV2PostEmvTags200Response.md b/docs/TssV2PostEmvTags200Response.md deleted file mode 100644 index 20ac9347..00000000 --- a/docs/TssV2PostEmvTags200Response.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2PostEmvTags200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parsed_emv_tags_list** | [**list[TssV2PostEmvTags200ResponseParsedEMVTagsList]**](TssV2PostEmvTags200ResponseParsedEMVTagsList.md) | An array of objects (one per object in the passed emvDetailsList), each of which contains a fully parsed EMV string | [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/TssV2PostEmvTags200ResponseEmvTagBreakdownList.md b/docs/TssV2PostEmvTags200ResponseEmvTagBreakdownList.md deleted file mode 100644 index d31ef973..00000000 --- a/docs/TssV2PostEmvTags200ResponseEmvTagBreakdownList.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2PostEmvTags200ResponseEmvTagBreakdownList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tag** | **str** | Hexadecimal code of tag. | [optional] -**name** | **str** | Name of tag. | [optional] -**length** | **int** | Tag length in bytes. | [optional] -**value** | **str** | Hexadecimal value contained in the tag, masked data is represented by an 'X'. | [optional] -**description** | **str** | Description of tag. | [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/TssV2PostEmvTags200ResponseParsedEMVTagsList.md b/docs/TssV2PostEmvTags200ResponseParsedEMVTagsList.md deleted file mode 100644 index 86b203dc..00000000 --- a/docs/TssV2PostEmvTags200ResponseParsedEMVTagsList.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2PostEmvTags200ResponseParsedEMVTagsList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**total_tags** | **int** | Number of tags parsed | [optional] -**emv_tag_breakdown_list** | [**list[TssV2PostEmvTags200ResponseEmvTagBreakdownList]**](TssV2PostEmvTags200ResponseEmvTagBreakdownList.md) | An array of objects, where each object contains one parsed tag from the relevant EMV string. | [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/TssV2TransactionsGet200Response.md b/docs/TssV2TransactionsGet200Response.md deleted file mode 100644 index c8108a01..00000000 --- a/docs/TssV2TransactionsGet200Response.md +++ /dev/null @@ -1,40 +0,0 @@ -# TssV2TransactionsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**root_id** | **str** | Contains the transaction identifier for the first transaction in the series of transactions. For example, you might send an authorization request for a payment, followed by a capture request for that payment, and then a refund request for that captured payment. Each of those requests, if successful, creates a resource that is assigned an identifier, which is returned in the response. The rootId identifies the first ID in the series, which in this case would be the ID of the original authorization. | [optional] -**reconciliation_id** | **str** | 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] -**merchant_id** | **str** | Your CyberSource merchant ID. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. | [optional] -**application_information** | [**TssV2TransactionsGet200ResponseApplicationInformation**](TssV2TransactionsGet200ResponseApplicationInformation.md) | | [optional] -**bank_account_validation** | [**TssV2TransactionsGet200ResponseBankAccountValidation**](TssV2TransactionsGet200ResponseBankAccountValidation.md) | | [optional] -**buyer_information** | [**TssV2TransactionsGet200ResponseBuyerInformation**](TssV2TransactionsGet200ResponseBuyerInformation.md) | | [optional] -**client_reference_information** | [**TssV2TransactionsGet200ResponseClientReferenceInformation**](TssV2TransactionsGet200ResponseClientReferenceInformation.md) | | [optional] -**consumer_authentication_information** | [**TssV2TransactionsGet200ResponseConsumerAuthenticationInformation**](TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md) | | [optional] -**device_information** | [**TssV2TransactionsGet200ResponseDeviceInformation**](TssV2TransactionsGet200ResponseDeviceInformation.md) | | [optional] -**error_information** | [**TssV2TransactionsGet200ResponseErrorInformation**](TssV2TransactionsGet200ResponseErrorInformation.md) | | [optional] -**installment_information** | [**TssV2TransactionsGet200ResponseInstallmentInformation**](TssV2TransactionsGet200ResponseInstallmentInformation.md) | | [optional] -**fraud_marking_information** | [**TssV2TransactionsGet200ResponseFraudMarkingInformation**](TssV2TransactionsGet200ResponseFraudMarkingInformation.md) | | [optional] -**health_care_information** | [**Ptsv2paymentsHealthCareInformation**](Ptsv2paymentsHealthCareInformation.md) | | [optional] -**merchant_defined_information** | [**list[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] -**merchant_information** | [**TssV2TransactionsGet200ResponseMerchantInformation**](TssV2TransactionsGet200ResponseMerchantInformation.md) | | [optional] -**order_information** | [**TssV2TransactionsGet200ResponseOrderInformation**](TssV2TransactionsGet200ResponseOrderInformation.md) | | [optional] -**payment_information** | [**TssV2TransactionsGet200ResponsePaymentInformation**](TssV2TransactionsGet200ResponsePaymentInformation.md) | | [optional] -**payment_insights_information** | [**PtsV2PaymentsPost201ResponsePaymentInsightsInformation**](PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md) | | [optional] -**payout_options** | [**TssV2TransactionsGet200ResponsePayoutOptions**](TssV2TransactionsGet200ResponsePayoutOptions.md) | | [optional] -**unscheduled_payment_information** | [**Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) | | [optional] -**processing_information** | [**TssV2TransactionsGet200ResponseProcessingInformation**](TssV2TransactionsGet200ResponseProcessingInformation.md) | | [optional] -**processor_information** | [**TssV2TransactionsGet200ResponseProcessorInformation**](TssV2TransactionsGet200ResponseProcessorInformation.md) | | [optional] -**recurring_payment_information** | [**TssV2TransactionsGet200ResponseRecurringPaymentInformation**](TssV2TransactionsGet200ResponseRecurringPaymentInformation.md) | | [optional] -**point_of_sale_information** | [**TssV2TransactionsGet200ResponsePointOfSaleInformation**](TssV2TransactionsGet200ResponsePointOfSaleInformation.md) | | [optional] -**risk_information** | [**TssV2TransactionsGet200ResponseRiskInformation**](TssV2TransactionsGet200ResponseRiskInformation.md) | | [optional] -**sender_information** | [**TssV2TransactionsGet200ResponseSenderInformation**](TssV2TransactionsGet200ResponseSenderInformation.md) | | [optional] -**token_information** | [**TssV2TransactionsGet200ResponseTokenInformation**](TssV2TransactionsGet200ResponseTokenInformation.md) | | [optional] -**links** | [**TssV2TransactionsGet200ResponseLinks**](TssV2TransactionsGet200ResponseLinks.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/TssV2TransactionsGet200ResponseApplicationInformation.md b/docs/TssV2TransactionsGet200ResponseApplicationInformation.md deleted file mode 100644 index 8c221623..00000000 --- a/docs/TssV2TransactionsGet200ResponseApplicationInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsGet200ResponseApplicationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **str** | The status of the submitted transaction. | [optional] -**reason_code** | **str** | Indicates the reason why a request succeeded or failed and possible action to take if a request fails. For details, see the appendix of reason codes in the documentation for the relevant payment method. | [optional] -**r_code** | **str** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional] -**r_flag** | **str** | One-word description of the result of the application. | [optional] -**applications** | [**list[TssV2TransactionsGet200ResponseApplicationInformationApplications]**](TssV2TransactionsGet200ResponseApplicationInformationApplications.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/TssV2TransactionsGet200ResponseApplicationInformationApplications.md b/docs/TssV2TransactionsGet200ResponseApplicationInformationApplications.md deleted file mode 100644 index c3466659..00000000 --- a/docs/TssV2TransactionsGet200ResponseApplicationInformationApplications.md +++ /dev/null @@ -1,17 +0,0 @@ -# TssV2TransactionsGet200ResponseApplicationInformationApplications - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the CyberSource transaction type (such as CC settlement or CC authorization) that the merchant wants to process in a transaction request. More than one transaction type can included in a transaction request. Each transaction type separately returns their own status, reasonCode, rCode, and rFlag messages. | [optional] -**status** | **str** | The description for this field is not available. | [optional] -**reason_code** | **str** | 3-digit reason code that indicates why the customer profile payment succeeded or failed. | [optional] -**r_code** | **str** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional] -**r_flag** | **str** | One-word description of the result of the application. | [optional] -**reconciliation_id** | **str** | Reference number that you use to reconcile your CyberSource reports with your processor reports. | [optional] -**r_message** | **str** | Message that explains the reply flag for the application. | [optional] -**return_code** | **int** | The description for this field is not available. | [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/TssV2TransactionsGet200ResponseBankAccountValidation.md b/docs/TssV2TransactionsGet200ResponseBankAccountValidation.md deleted file mode 100644 index a33ff737..00000000 --- a/docs/TssV2TransactionsGet200ResponseBankAccountValidation.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsGet200ResponseBankAccountValidation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**raw_validation_code** | **int** | Raw Validation Codes for routing number and account number Possible values: • -1: Unable to perform validation/Unknown error • -2: Service Unavailable • 12 to 16: Validation results | [optional] -**result_code** | **int** | Result codes for account number and routing number Possible values: 00, 04, 98, 99 | [optional] -**result_message** | **str** | | [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/TssV2TransactionsGet200ResponseBuyerInformation.md b/docs/TssV2TransactionsGet200ResponseBuyerInformation.md deleted file mode 100644 index 76a3c624..00000000 --- a/docs/TssV2TransactionsGet200ResponseBuyerInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_customer_id** | **str** | 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] -**hashed_password** | **str** | 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/TssV2TransactionsGet200ResponseClientReferenceInformation.md b/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md deleted file mode 100644 index 0e23d523..00000000 --- a/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# TssV2TransactionsGet200ResponseClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | 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] -**application_version** | **str** | Version of the CyberSource application or integration used for a transaction. | [optional] -**application_name** | **str** | 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] -**application_user** | **str** | 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. | [optional] -**partner** | [**TssV2TransactionsGet200ResponseClientReferenceInformationPartner**](TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md) | | [optional] -**comments** | **str** | 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/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md b/docs/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md deleted file mode 100644 index c55f9d71..00000000 --- a/docs/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseClientReferenceInformationPartner - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**solution_id** | **str** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [optional] -**third_party_certification_number** | **str** | Value that identifies the application vendor and application version for a third party gateway. CyberSource provides you with this value during testing and validation. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization, Authorization Reversal, Capture, Credit, Incremental Authorization, and Void** Optional field. #### PIN debit Required field for PIN debit credit, PIN debit purchase, or PIN debit reversal request. | [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/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md deleted file mode 100644 index eb684e6a..00000000 --- a/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsGet200ResponseConsumerAuthenticationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**eci_raw** | **str** | Raw electronic commerce indicator (ECI). | [optional] -**cavv** | **str** | Cardholder authentication verification value (CAVV). | [optional] -**xid** | **str** | Transaction identifier. | [optional] -**transaction_id** | **str** | Payer auth Transaction identifier. | [optional] -**strong_authentication** | [**TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication**](TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.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/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md deleted file mode 100644 index be33567e..00000000 --- a/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**low_value_exemption_indicator** | **str** | This field will contain the low value exemption indicator with one of the following values: Possible values: - `0` ( low value exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it to be a low value payment) | [optional] -**risk_analysis_exemption_indicator** | **str** | This field will contain the transaction risk analysis exemption indicator with one of the following values: Possible values: - `0` (TRA exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it to be low risk in accordance with the criteria defined by PSD2/RTS) | [optional] -**trusted_merchant_exemption_indicator** | **str** | Possible values: - `0` (Trusted merchant exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as it originated at a merchant trusted by the cardholder) | [optional] -**secure_corporate_payment_indicator** | **str** | This field will contain the secure corporate payment exemption indicator with one of the following values: Possible values: - `0` (SCA exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it as a secure corporate payment) | [optional] -**delegated_authentication_exemption_indicator** | **str** | This field will contain the delegated authentication exemption indicator with one of the following values: Possible values: - `0` (delegated Authentication exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as authentication has been delegated to other provider (PSP,Acquirer)) | [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/TssV2TransactionsGet200ResponseDeviceInformation.md b/docs/TssV2TransactionsGet200ResponseDeviceInformation.md deleted file mode 100644 index dc4c6da0..00000000 --- a/docs/TssV2TransactionsGet200ResponseDeviceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsGet200ResponseDeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] -**host_name** | **str** | DNS resolved hostname from `ipAddress`. | [optional] -**cookies_accepted** | **str** | Whether the customer's browser accepts cookies. This field can contain one of the following values: - `yes`: The customer's browser accepts cookies. - `no`: The customer's browser does not accept cookies. | [optional] - -[[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/TssV2TransactionsGet200ResponseErrorInformation.md b/docs/TssV2TransactionsGet200ResponseErrorInformation.md deleted file mode 100644 index c1eca3a0..00000000 --- a/docs/TssV2TransactionsGet200ResponseErrorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsGet200ResponseErrorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | 1-word description of why a request succeeded or failed. | [optional] -**message** | **str** | The user-facing description for why a request succeeded or failed. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/TssV2TransactionsGet200ResponseFraudMarkingInformation.md b/docs/TssV2TransactionsGet200ResponseFraudMarkingInformation.md deleted file mode 100644 index 452b4333..00000000 --- a/docs/TssV2TransactionsGet200ResponseFraudMarkingInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponseFraudMarkingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | Reason for adding the transaction to the negative list. This field can contain one of the following values: - fraud_chargeback: You have received a fraudrelated chargeback for the transaction. - non_fraud_chargeback: You have received a non-fraudulent chargeback for the transaction. - suspected: You believe that you will probably receive a chargeback for the transaction. - creditback: You issued a refund to the customer to avoid a chargeback for the 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/TssV2TransactionsGet200ResponseInstallmentInformation.md b/docs/TssV2TransactionsGet200ResponseInstallmentInformation.md deleted file mode 100644 index 65753d0b..00000000 --- a/docs/TssV2TransactionsGet200ResponseInstallmentInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseInstallmentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number_of_installments** | **str** | Number of Installments. | [optional] -**identifier** | **str** | Standing Instruction/Installment identifier. | [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/TssV2TransactionsGet200ResponseLinks.md b/docs/TssV2TransactionsGet200ResponseLinks.md deleted file mode 100644 index cdb51294..00000000 --- a/docs/TssV2TransactionsGet200ResponseLinks.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.md) | | [optional] -**related_transactions** | [**list[PtsV2PaymentsPost201ResponseLinksSelf]**](PtsV2PaymentsPost201ResponseLinksSelf.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/TssV2TransactionsGet200ResponseMerchantInformation.md b/docs/TssV2TransactionsGet200ResponseMerchantInformation.md deleted file mode 100644 index 6dbe047b..00000000 --- a/docs/TssV2TransactionsGet200ResponseMerchantInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponseMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_descriptor** | [**TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor**](TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.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/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.md b/docs/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.md deleted file mode 100644 index 58dc4285..00000000 --- a/docs/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. **Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. **Important** This value must consist of English characters. Required for captures and credits. | [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/TssV2TransactionsGet200ResponseOrderInformation.md b/docs/TssV2TransactionsGet200ResponseOrderInformation.md deleted file mode 100644 index 84ddea2d..00000000 --- a/docs/TssV2TransactionsGet200ResponseOrderInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# TssV2TransactionsGet200ResponseOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bill_to** | [**TssV2TransactionsGet200ResponseOrderInformationBillTo**](TssV2TransactionsGet200ResponseOrderInformationBillTo.md) | | [optional] -**ship_to** | [**TssV2TransactionsGet200ResponseOrderInformationShipTo**](TssV2TransactionsGet200ResponseOrderInformationShipTo.md) | | [optional] -**line_items** | [**list[TssV2TransactionsGet200ResponseOrderInformationLineItems]**](TssV2TransactionsGet200ResponseOrderInformationLineItems.md) | Transaction Line Item data. | [optional] -**amount_details** | [**TssV2TransactionsGet200ResponseOrderInformationAmountDetails**](TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md) | | [optional] -**shipping_details** | [**TssV2TransactionsGet200ResponseOrderInformationShippingDetails**](TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md) | | [optional] -**invoice_details** | [**TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails**](TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.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/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md deleted file mode 100644 index 87134df8..00000000 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md +++ /dev/null @@ -1,16 +0,0 @@ -# TssV2TransactionsGet200ResponseOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_amount** | **str** | 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 / Pay By Link Required for creating a new invoice or payment link. #### 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** | **str** | 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] -**tax_amount** | **str** | Total tax amount for all the items in the order. | [optional] -**authorized_amount** | **str** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. | [optional] -**settlement_amount** | **str** | 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] -**settlement_currency** | **str** | 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** | [**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/TssV2TransactionsGet200ResponseOrderInformationBillTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md deleted file mode 100644 index b7f1f310..00000000 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md +++ /dev/null @@ -1,23 +0,0 @@ -# TssV2TransactionsGet200ResponseOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**first_name** | **str** | 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] -**last_name** | **str** | 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] -**middle_name** | **str** | Customer's middle name. | [optional] -**name_suffix** | **str** | Customer's name suffix. | [optional] -**address1** | **str** | 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] -**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] -**locality** | **str** | 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] -**administrative_area** | **str** | 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] -**postal_code** | **str** | 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** | **str** | 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** | **str** | 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** | **str** | 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** | **str** | Title. | [optional] -**phone_number** | **str** | 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/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.md deleted file mode 100644 index 3f1d428b..00000000 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sales_slip_number** | **int** | Transaction identifier that is generated. You have the option of printing the sales slip number on the receipt. This field is supported only on Cybersource through Visanet and JCN gateway. Optional field. #### Card Present processing message If you included this field in the request, the returned value is the value that you sent in the request. If you did not include this field in the request, the system generated this value for you. The difference between this reply field and the `processorInformation.systemTraceAuditNumber` field is that the system generates the system trace audit number (STAN), and you must print the receipt number on the receipt; whereas you can generate the sales slip number, and you can choose to print the sales slip number on the receipt. | [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/TssV2TransactionsGet200ResponseOrderInformationLineItems.md b/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md deleted file mode 100644 index e7fa1f8c..00000000 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md +++ /dev/null @@ -1,16 +0,0 @@ -# TssV2TransactionsGet200ResponseOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**product_code** | **str** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] -**product_name** | **str** | For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**product_sku** | **str** | Identification code for the product. For Payment and Capture APIs, this field is required when above `productCode` is not **default** or one of the values related to shipping and/or handling. | [optional] -**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. | [optional] -**quantity** | **int** | For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**unit_price** | **str** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. | [optional] -**fulfillment_type** | **str** | The description for this field is not available. | [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/TssV2TransactionsGet200ResponseOrderInformationShipTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md deleted file mode 100644 index 1471585b..00000000 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md +++ /dev/null @@ -1,19 +0,0 @@ -# TssV2TransactionsGet200ResponseOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**administrative_area** | **str** | 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] -**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**company** | **str** | Name of the customer's company. | [optional] -**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**phone_number** | **str** | Phone number associated with the shipping 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/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md deleted file mode 100644 index ddc5d2a1..00000000 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseOrderInformationShippingDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**gift_wrap** | **bool** | Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping. | [optional] -**shipping_method** | **str** | Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription | [optional] - -[[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/TssV2TransactionsGet200ResponsePaymentInformation.md b/docs/TssV2TransactionsGet200ResponsePaymentInformation.md deleted file mode 100644 index 8a2214e9..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformation.md +++ /dev/null @@ -1,23 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_type** | [**TssV2TransactionsGet200ResponsePaymentInformationPaymentType**](TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md) | | [optional] -**customer** | [**TssV2TransactionsGet200ResponsePaymentInformationCustomer**](TssV2TransactionsGet200ResponsePaymentInformationCustomer.md) | | [optional] -**card** | [**TssV2TransactionsGet200ResponsePaymentInformationCard**](TssV2TransactionsGet200ResponsePaymentInformationCard.md) | | [optional] -**brands** | [**list[TssV2TransactionsGet200ResponsePaymentInformationBrands]**](TssV2TransactionsGet200ResponsePaymentInformationBrands.md) | This array contains the supported brands. | [optional] -**features** | [**TssV2TransactionsGet200ResponsePaymentInformationFeatures**](TssV2TransactionsGet200ResponsePaymentInformationFeatures.md) | | [optional] -**invoice** | [**TssV2TransactionsGet200ResponsePaymentInformationInvoice**](TssV2TransactionsGet200ResponsePaymentInformationInvoice.md) | | [optional] -**network** | [**TssV2TransactionsGet200ResponsePaymentInformationNetwork**](TssV2TransactionsGet200ResponsePaymentInformationNetwork.md) | | [optional] -**issuer_information** | [**TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation**](TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md) | | [optional] -**bank** | [**TssV2TransactionsGet200ResponsePaymentInformationBank**](TssV2TransactionsGet200ResponsePaymentInformationBank.md) | | [optional] -**account_features** | [**TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures**](TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md) | | [optional] -**payment_instrument** | [**PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument**](PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument.md) | | [optional] -**instrument_identifier** | [**TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier**](TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md) | | [optional] -**shipping_address** | [**PtsV2PaymentsPost201ResponseTokenInformationShippingAddress**](PtsV2PaymentsPost201ResponseTokenInformationShippingAddress.md) | | [optional] -**fluid_data** | [**TssV2TransactionsGet200ResponsePaymentInformationFluidData**](TssV2TransactionsGet200ResponsePaymentInformationFluidData.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/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md deleted file mode 100644 index d09f223e..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**balance_amount** | **str** | Remaining balance on the account. Returned by authorization service. #### PIN debit Remaining balance on the prepaid card. Returned by PIN debit purchase. | [optional] -**previous_balance_amount** | **str** | Remaining balance on the account. Returned by authorization service. #### PIN debit Remaining balance on the prepaid card. Returned by PIN debit purchase. | [optional] -**currency** | **str** | Currency of the remaining balance on the account. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) Returned by authorization service. #### PIN debit Currency of the remaining balance on the prepaid card. Returned by PIN debit purchase. | [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/TssV2TransactionsGet200ResponsePaymentInformationBank.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md deleted file mode 100644 index 3815d59e..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md +++ /dev/null @@ -1,16 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationBank - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**routing_number** | **str** | Bank routing number. This is also called the transit number. | [optional] -**branch_code** | **str** | 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] -**swift_code** | **str** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] -**bank_code** | **str** | 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** | **str** | 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** | [**TssV2TransactionsGet200ResponsePaymentInformationBankAccount**](TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md) | | [optional] -**mandate** | [**TssV2TransactionsGet200ResponsePaymentInformationBankMandate**](TssV2TransactionsGet200ResponsePaymentInformationBankMandate.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/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md deleted file mode 100644 index c93a442f..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md +++ /dev/null @@ -1,16 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationBankAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**suffix** | **str** | Last four digits of the customer's payment account number. | [optional] -**prefix** | **str** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. | [optional] -**check_number** | **str** | 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** | **str** | 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** | **str** | Name used on the bank account. You can use this field only when scoring a direct debit transaction | [optional] -**check_digit** | **str** | 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] -**encoder_id** | **str** | 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/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md deleted file mode 100644 index 4e1f39e2..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationBankMandate - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reference_number** | **str** | Unique value generated by CyberSource that identifies the transaction. Use this value to identify transactions in the Collections Report, which provides settlement information. For details, see the `direct_debit_reconciliation_reference_number` reply field description in [Ingenico ePayments Developer Guide For Direct Debits.](https://apps.cybersource.com/library/documentation/dev_guides/Ingenico_ePayments_Dev/html/) | [optional] -**recurring_type** | **str** | Whether the direct debit is the first or last direct debit associated with the mandate, or one in between. Required only for the United Kingdom. Possible values: - `001`: First direct debit associated with this mandate. Use this value if a one-time direct debit). - `002`: Subsequent direct debits associated with this mandate. - `003`: Last direct debit associated with this mandate. For details, see the `direct_debit_recurring_type` request field description in [Ingenico ePayments Developer Guide For Direct Debits.](https://apps.cybersource.com/library/documentation/dev_guides/Ingenico_ePayments_Dev/html/) | [optional] -**id** | **str** | The mandate ID. Required only for the United Kingdom. For details, see the `mandate_id` request field description in [Ingenico ePayments Developer Guide For Direct Debits.](https://apps.cybersource.com/library/documentation/dev_guides/Ingenico_ePayments_Dev/html/) | [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/TssV2TransactionsGet200ResponsePaymentInformationBrands.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBrands.md deleted file mode 100644 index ab722c60..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationBrands.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationBrands - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [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/TssV2TransactionsGet200ResponsePaymentInformationCard.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md deleted file mode 100644 index 8e39b879..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md +++ /dev/null @@ -1,21 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**suffix** | **str** | Last four digits of the cardholder's account number. This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### PIN debit This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. Returned by PIN debit credit and PIN debit purchase. This field is supported only by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional] -**prefix** | **str** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] -**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] -**expiration_year** | **str** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] -**start_month** | **str** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] -**start_year** | **str** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] -**issue_number** | **str** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. | [optional] -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [optional] -**currency** | **str** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional] -**account_encoder_id** | **str** | Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID. | [optional] -**use_as** | **str** | Flag that specifies the type of account associated with the card. This field is available only for China UnionPay, Cielo, Comercio Latino and Visa Platform Connect. The cardholder provides this information during the payment process. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **China UnionPayCard Transactions on China UnionPay:** Possible values: - C: Domestic credit card - D: Domestic debit card - F: International credit card - I: International debit card When the value is D, the e-commerce indicator and CAVV fields must be included in the authorization request. When the value is C, F or I the card verification number, expiration month and expiration year fields must in included in the authorization request. **Cielo and Comercio Latino Credit Card Transactions:** On these processors, this field is supported only for authorizations. Possible values: - CR: Credit card - DB: Debit card **Visa Platform Connect Credit Card Transactions:** This field is supported for all card types on Visa Platform Connect. For combo **card present** transactions with Mastercard on Brazilian-issued cards, possible values: - CR: Credit card - DB: Debit Card For combo **card not present** transactions with Mastercard on Brazilian-issued cards, possible values: - C: Credit card - D: Debit card A value of CR or DB in the useAs field takes precedence over any value in the Source Account Type 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/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md deleted file mode 100644 index cd7a0c95..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_id** | **str** | 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** | **str** | 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/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md deleted file mode 100644 index 5f636bdc..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md +++ /dev/null @@ -1,16 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationFeatures - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_funding_source** | **str** | This field contains the account funding source. Possible values: - `CREDIT` - `DEBIT` - `PREPAID` - `DEFERRED DEBIT` - `CHARGE` | [optional] -**account_funding_source_sub_type** | **str** | This field contains the type of prepaid card. Possible values: - `Reloadable` - `Non-reloadable` | [optional] -**card_product** | **str** | This field contains the type of issuer product. Example values: - Visa Classic - Visa Signature - Visa Infinite | [optional] -**message_type** | **str** | This field contains the type of BIN based authentication. Possible values: - `S`: Single Message - `D`: Dual Message | [optional] -**acceptance_level** | **str** | This field contains the acceptance level of the PAN. Possible values: - `0` : Normal - `1` : Monitor - `2` : Refuse - `3` : Not Allowed - `4` : Private - `5` : Test | [optional] -**card_platform** | **str** | This field contains the type of card platform. Possible values: - `BUSINESS` - `CONSUMER` - `COMMERCIAL` - `GOVERNMENT` | [optional] -**combo_card** | **str** | This field indicates the type of combo card. Possible values: - 0 (Not a combo card) - 1 (Credit and Prepaid Combo card) - 2 (Credit and Debit Combo card) | [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/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md deleted file mode 100644 index 9a4f86de..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationFluidData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**descriptor** | **str** | The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is `Ymx1ZWZpbg==`. paymentInformation.fluidData.encoding must be `Base64`. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is `Base64`, the value is: `RklEPUVNVi5QQVlNRU5ULkFQSQ==` If paymentInformation.fluidData.encoding is `HEX`, the value is: `4649443D454D562E5041594D454E542E41504` | [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/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md deleted file mode 100644 index 7e572116..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Unique identifier for the Instrument Identifier 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/TssV2TransactionsGet200ResponsePaymentInformationInvoice.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationInvoice.md deleted file mode 100644 index 1584793b..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationInvoice.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationInvoice - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **str** | Invoice Number. | [optional] -**barcode_number** | **str** | Barcode Number. | [optional] -**expiration_date** | **str** | Expiration Date. | [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/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md deleted file mode 100644 index 6ac1028f..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | This field contains the issuer name. | [optional] -**country** | **str** | This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. | [optional] -**bin_length** | **str** | This field contains the length of the BIN. | [optional] -**phone_number** | **str** | This field contains the customer service phone number for the issuer. | [optional] -**transaction_information** | **str** | In a Mastercard Transaction, this field contains the unique identifier (Transaction Link ID) for the first transaction in a transaction life cycle. This ID is crucial for maintaining continuity and linking subsequent operations to the original 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/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md deleted file mode 100644 index e320d2e2..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationNetwork - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | This field contains a code that identifies the network. Please refer [Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_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/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md deleted file mode 100644 index b0c556f5..00000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsGet200ResponsePaymentInformationPaymentType - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank, KCP) - `localCard` (KCP Local card via Altpay) - `carrierBilling` (KCP Carrier Billing via Altpay) | [optional] -**type** | **str** | Indicates the payment type used in this payment transaction. Example: credit card, check | [optional] -**method** | **str** | Indicates the payment method used in this payment 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/TssV2TransactionsGet200ResponsePayoutOptions.md b/docs/TssV2TransactionsGet200ResponsePayoutOptions.md deleted file mode 100644 index 94958769..00000000 --- a/docs/TssV2TransactionsGet200ResponsePayoutOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponsePayoutOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payout_inquiry** | **str** | If true then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup. Possible values: - `true` - `false` | [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/TssV2TransactionsGet200ResponsePointOfSaleInformation.md b/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md deleted file mode 100644 index 1da6c9bc..00000000 --- a/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsGet200ResponsePointOfSaleInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminal_id** | **str** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional] -**entry_mode** | **str** | Method of entering payment card information into the POS terminal. Possible values: - `contact`: Read from direct contact with chip card. - `contactless`: Read from a contactless interface using chip data. - `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - `swiped`: Read from credit card magnetic stripe. The `contact`, `contactless`, and `msd` values are supported only for EMV transactions. #### Used by **Authorization** Required field. #### Card Present Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. #### PIN debit Required for a PIN debit purchase and a PIN debit credit request. | [optional] -**terminal_capability** | **int** | POS terminal's capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards. - `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be `4` or `5`. #### PIN debit Required for PIN debit purchase and PIN debit credit request. #### Used by **Authorization** Required for the following processors: - American Express Direct - Chase Paymentech Solutions - Credit Mutuel-CIC - FDC Nashville Global - FDMS Nashville - OmniPay Direct - SIX - Worldpay VAP Optional for the following processors: - CyberSource through VisaNet - GPN - GPX - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions | [optional] -**cardholder_verification_method_used** | **int** | Method that was used to verify the cardholder's identity. Possible values: - `0`: No verification - `1`: Signature - `2`: PIN - `3`: Cardholder device CVM - `4`: Biometric - `5`: OTP | [optional] -**emv** | [**Ptsv2paymentsidreversalsPointOfSaleInformationEmv**](Ptsv2paymentsidreversalsPointOfSaleInformationEmv.md) | | [optional] - -[[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/TssV2TransactionsGet200ResponseProcessingInformation.md b/docs/TssV2TransactionsGet200ResponseProcessingInformation.md deleted file mode 100644 index 80f86f89..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformation.md +++ /dev/null @@ -1,21 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bin_source** | **str** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional] -**industry_data_type** | **str** | 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] -**payment_solution** | **str** | Type of digital payment solution for the transaction. | [optional] -**commerce_indicator** | **str** | 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] -**commerce_indicator_label** | **str** | 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] -**business_application_id** | **str** | Required for AFT and OCT transactions. Given below is a list of all the BAI values available. However, the processors may support only few specific BAI values. - AA : Account-to-account - BB : Supplier Payments - BI : Bank-Initiated P2P Money Transfer - BP : Non-Card Bill Pay/Bill Pay - CD : Cash Deposit - CP : Credit card Bill Payment - FD : Funds disbursement - FT : Funds transfer - GD : Government Disbursement - GP : Gambling payout (non-online gambling) - LO : Loyalty credits and rebates - MD : Merchant Settlement - OG : Online Gambling Payout - PD : Payroll and pension disbursement - PP : Person-to-Person or Peer-to-Peer - TU : Top up, prepaid load - WT : Digital wallet | [optional] -**authorization_options** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md) | | [optional] -**bank_transfer_options** | [**TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions**](TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md) | | [optional] -**capture_options** | [**TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions**](TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md) | | [optional] -**reconciliation_id** | **str** | 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] -**japan_payment_options** | [**TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions**](TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md) | | [optional] -**validation_level** | **int** | Enter 1 for routing and account number validation. | [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/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md deleted file mode 100644 index 68a500bc..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**auth_type** | **str** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. #### for PayPal ptsV2CreateOrderPost400Response Set this field to 'AUTHORIZE' or 'CAPTURE' depending on whether you want to invoke delayed capture or sale respectively. | [optional] -**auth_indicator** | **str** | 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] -**extend_auth_indicator** | **str** | Indicates Authorization extension transaction. Extension transaction is used to prolong the settlement period by one additional settlement cycle period. Possible values: - true: Transaction is an Authorization Extension transaction. - false: Transaction is not an Authorization Extension transaction. | [optional] -**card_verification_indicator** | **bool** | This API field will indicate whether a card verification check is being performed during the transaction Possible values: - `true` - `false` (default value) | [optional] -**initiator** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] - -[[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/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md deleted file mode 100644 index 8d5f4696..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md +++ /dev/null @@ -1,13 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** | [optional] -**credential_stored_on_file** | **str** | 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: - `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `N` 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] -**stored_credential_used** | **str** | Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file. Possible values: - **Y** means the merchant-initiated transaction came from a card that was already stored on file. - **N** means the merchant-initiated transaction came from a card that was not stored on file. | [optional] -**merchant_initiated_transaction** | [**MerchantInitiatedTransactionObject**](MerchantInitiatedTransactionObject.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/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md deleted file mode 100644 index 4acf0adc..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sec_code** | **str** | Specifies the authorization method for the transaction. Possible values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry | [optional] - -[[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/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md deleted file mode 100644 index 3f86bbc9..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_capture_count** | **int** | Total number of captures when requesting multiple partial captures for one payment. Used along with `captureSequenceNumber` field to track which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - `captureSequenceNumber = 2`, and - `totalCaptureCount = 5` | [optional] -**capture_sequence_number** | **int** | Capture number when requesting multiple partial captures for one authorization. Used along with `totalCaptureCount` to track which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - `captureSequenceNumber_ = 2`, and - `totalCaptureCount = 5` | [optional] - -[[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/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md deleted file mode 100644 index e06856a9..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md +++ /dev/null @@ -1,18 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_method** | **str** | This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment) | [optional] -**terminal_id** | **str** | Unique Japan Credit Card Association (JCCA) terminal identifier. The difference between this field and the `pointOfSaleInformation.terminalID` field is that you can define `pointOfSaleInformation.terminalID`, but `processingInformation.japanPaymentOptions.terminalId` is defined by the JCCA and is used only in Japan. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field. | [optional] -**business_name** | **str** | Business name in Japanese characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional] -**business_name_katakana** | **str** | Business name in Katakana characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional] -**business_name_english** | **str** | Business name in English characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional] -**bonuses** | [**list[Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses]**](Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses.md) | An array of objects, each of which contains a bonus month and bonus amount. Length of bonuses array is equal to the number of bonuses. Max length = 6. In case of bonus month and amount not specified, null objects to be returned in the array. Example: bonuses : [ {\"month\": \"1\",\"amount\": \"200\"}, {\"month\": \"3\",\"amount\": \"2500\"}, null] | [optional] -**first_billing_month** | **str** | Billing month in MM format. | [optional] -**number_of_installments** | **str** | Number of Installments. | [optional] -**pre_approval_type** | **str** | This will contain the details of the kind of transaction that has been processe. Used only for Japan. Possible Values: - 0 = Normal (authorization with amount and clearing/settlement; data capture or paper draft) - 1 = Negative card authorization (authorization-only with 0 or 1 amount) - 2 = Reservation of authorization (authorization-only with amount) - 3 = Cancel transaction - 4 = Merchant-initiated reversal/refund transactions - 5 = Cancel reservation of authorization - 6 = Post authorization | [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/TssV2TransactionsGet200ResponseProcessorInformation.md b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md deleted file mode 100644 index 86d43c00..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformation.md +++ /dev/null @@ -1,26 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**processor** | [**TssV2TransactionsGet200ResponseProcessorInformationProcessor**](TssV2TransactionsGet200ResponseProcessorInformationProcessor.md) | | [optional] -**multi_processor_routing** | [**list[TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting]**](TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md) | An array of object that contains the list of acquirer response codes & reasons if a transaction is routed to multiple acquirers. | [optional] -**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] -**network_transaction_id** | **str** | Same value as `processorInformation.transactionId` | [optional] -**retrieval_reference_number** | **str** | #### Ingenico ePayments Unique number that CyberSource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report. ### CyberSource through VisaNet Retrieval request number. | [optional] -**response_id** | **str** | Response ID sent from the processor. | [optional] -**approval_code** | **str** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional] -**response_code** | **str** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail. | [optional] -**avs** | [**PtsV2PaymentsPost201ResponseProcessorInformationAvs**](PtsV2PaymentsPost201ResponseProcessorInformationAvs.md) | | [optional] -**card_verification** | [**Riskv1decisionsProcessorInformationCardVerification**](Riskv1decisionsProcessorInformationCardVerification.md) | | [optional] -**ach_verification** | [**PtsV2PaymentsPost201ResponseProcessorInformationAchVerification**](PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md) | | [optional] -**electronic_verification_results** | [**TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults**](TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md) | | [optional] -**event_status** | **str** | The event status. | [optional] -**system_trace_audit_number** | **str** | This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer's receipt. | [optional] -**response_code_source** | **str** | Used by Visa only and contains the response source/reason code that identifies the source of the response decision. | [optional] -**payment_account_reference_number** | **str** | Payment Account Reference (PAR) is a non-financial reference assigned to each unique payment account and used to link a payment account to associated network tokens, i.e. the same PAR is returned for PAN-based and tokenized transactions, such as from digital wallets. PAR can be returned in authorisation responses for requests initiated with both real PANs and tokenized PANs. PAR can be used by merchants for fraud detection and regulatory compliance across different channels and digital wallets. PAR allows all participants in the payments chain to have a single, non-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder identification fields, and transmitted across the payments ecosystem to facilitate card holder identification. **Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR8 - Position: 79-110 - Field: Payment Account Reference The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. | [optional] -**routing** | [**PtsV2PaymentsPost201ResponseProcessorInformationRouting**](PtsV2PaymentsPost201ResponseProcessorInformationRouting.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/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md deleted file mode 100644 index 0875a3ee..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md +++ /dev/null @@ -1,19 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **str** | Mapped Electronic Verification response code for the customer's email address. | [optional] -**email_raw** | **str** | Raw Electronic Verification response code from the processor for the customer's email address. | [optional] -**name** | **str** | #### 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] -**name_raw** | **str** | #### 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] -**phone_number** | **str** | Mapped Electronic Verification response code for the customer's phone number. | [optional] -**phone_number_raw** | **str** | Raw Electronic Verification response code from the processor for the customer's phone number. | [optional] -**street** | **str** | Mapped Electronic Verification response code for the customer's street address. | [optional] -**street_raw** | **str** | Raw Electronic Verification response code from the processor for the customer's street address. | [optional] -**postal_code** | **str** | Mapped Electronic Verification response code for the customer's postal code. | [optional] -**postal_code_raw** | **str** | 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/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md deleted file mode 100644 index d3b2f945..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md +++ /dev/null @@ -1,13 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the Processor. | [optional] -**response_code** | **str** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail. | [optional] -**reason_code** | **str** | Indicates the reason why a request succeeded or failed and possible action to take if a request fails. For details, see the appendix of reason codes in the documentation for the relevant payment method. | [optional] -**sequence** | **str** | The order in which the transaction was routed to the 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/TssV2TransactionsGet200ResponseProcessorInformationProcessor.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationProcessor.md deleted file mode 100644 index 7092c2ec..00000000 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformationProcessor.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponseProcessorInformationProcessor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the 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/TssV2TransactionsGet200ResponseRecurringPaymentInformation.md b/docs/TssV2TransactionsGet200ResponseRecurringPaymentInformation.md deleted file mode 100644 index 7025c592..00000000 --- a/docs/TssV2TransactionsGet200ResponseRecurringPaymentInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponseRecurringPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_type** | **str** | Indicates recurring amount type agreed by the cardholder Valid Values : 1- Fixed amount recurring payment 2- Recurring payment with maximum amount | [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/TssV2TransactionsGet200ResponseRiskInformation.md b/docs/TssV2TransactionsGet200ResponseRiskInformation.md deleted file mode 100644 index 5bfbe2d8..00000000 --- a/docs/TssV2TransactionsGet200ResponseRiskInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# TssV2TransactionsGet200ResponseRiskInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**profile** | [**TssV2TransactionsGet200ResponseRiskInformationProfile**](TssV2TransactionsGet200ResponseRiskInformationProfile.md) | | [optional] -**rules** | [**list[TssV2TransactionsGet200ResponseRiskInformationRules]**](TssV2TransactionsGet200ResponseRiskInformationRules.md) | | [optional] -**passive_profile** | [**TssV2TransactionsGet200ResponseRiskInformationProfile**](TssV2TransactionsGet200ResponseRiskInformationProfile.md) | | [optional] -**passive_rules** | [**list[TssV2TransactionsGet200ResponseRiskInformationRules]**](TssV2TransactionsGet200ResponseRiskInformationRules.md) | | [optional] -**score** | [**TssV2TransactionsGet200ResponseRiskInformationScore**](TssV2TransactionsGet200ResponseRiskInformationScore.md) | | [optional] -**local_time** | **str** | Time that the transaction was submitted in local time. Generated by Cybersource. | [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/TssV2TransactionsGet200ResponseRiskInformationProfile.md b/docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md deleted file mode 100644 index b2618333..00000000 --- a/docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseRiskInformationProfile - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the profile. | [optional] -**decision** | **str** | Decision returned by the profile; this field contains one of these values: - ACCEPT - REJECT - REVIEW | [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/TssV2TransactionsGet200ResponseRiskInformationRules.md b/docs/TssV2TransactionsGet200ResponseRiskInformationRules.md deleted file mode 100644 index a66901d5..00000000 --- a/docs/TssV2TransactionsGet200ResponseRiskInformationRules.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseRiskInformationRules - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Description of the rule as it appears in the Profile Editor. | [optional] -**decision** | **str** | Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` | [optional] - -[[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/TssV2TransactionsGet200ResponseRiskInformationScore.md b/docs/TssV2TransactionsGet200ResponseRiskInformationScore.md deleted file mode 100644 index a22ed99b..00000000 --- a/docs/TssV2TransactionsGet200ResponseRiskInformationScore.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsGet200ResponseRiskInformationScore - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**factor_codes** | **list[str]** | Array of factor codes. | [optional] -**result** | **int** | The description for this field is not available. | [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/TssV2TransactionsGet200ResponseSenderInformation.md b/docs/TssV2TransactionsGet200ResponseSenderInformation.md deleted file mode 100644 index 23a18cf8..00000000 --- a/docs/TssV2TransactionsGet200ResponseSenderInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsGet200ResponseSenderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reference_number** | **str** | Reference number generated by you that uniquely identifies the sender. | [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/TssV2TransactionsGet200ResponseTokenInformation.md b/docs/TssV2TransactionsGet200ResponseTokenInformation.md deleted file mode 100644 index 0b6d5c2b..00000000 --- a/docs/TssV2TransactionsGet200ResponseTokenInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# TssV2TransactionsGet200ResponseTokenInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer** | [**PtsV2PaymentsPost201ResponseTokenInformationCustomer**](PtsV2PaymentsPost201ResponseTokenInformationCustomer.md) | | [optional] -**payment_instrument** | [**PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument**](PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument.md) | | [optional] -**shipping_address** | [**PtsV2PaymentsPost201ResponseTokenInformationShippingAddress**](PtsV2PaymentsPost201ResponseTokenInformationShippingAddress.md) | | [optional] -**instrument_identifier** | [**TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier**](TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md) | | [optional] -**jti** | **str** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [optional] -**transient_token_jwt** | **str** | Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. | [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/TssV2TransactionsPost201Response.md b/docs/TssV2TransactionsPost201Response.md deleted file mode 100644 index 9e3c668d..00000000 --- a/docs/TssV2TransactionsPost201Response.md +++ /dev/null @@ -1,22 +0,0 @@ -# TssV2TransactionsPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**search_id** | **str** | An unique identification number assigned by CyberSource to identify each Search request. | [optional] -**save** | **bool** | Indicates whether or not you want to save this search request for future use. The options are: * `true` * `false` (default value) If set to `true`, this field returns `searchID` in the response. You can use this value to retrieve the details of the saved search. | [optional] -**name** | **str** | Name of this search. When `save` is set to `true`, this search is saved with this name. | [optional] -**timezone** | **str** | Merchant's time zone in ISO standard, using the TZ database format. For example: `America/Chicago` | [optional] -**query** | **str** | String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn-search-intro/txn-filtering.html) section of the Transaction Search Developer Guide. | [optional] -**offset** | **int** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional] -**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional] -**sort** | **str** | A comma separated list of the following form: `submitTimeUtc:desc` | [optional] -**count** | **int** | Results for this page, this could be below the limit. | [optional] -**total_count** | **int** | Total number of results. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**embedded** | [**TssV2TransactionsPost201ResponseEmbedded**](TssV2TransactionsPost201ResponseEmbedded.md) | | [optional] -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.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/TssV2TransactionsPost201ResponseEmbedded.md b/docs/TssV2TransactionsPost201ResponseEmbedded.md deleted file mode 100644 index 4920dc0f..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbedded.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction_summaries** | [**list[TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries]**](TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md) | transaction search summary | [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/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md deleted file mode 100644 index 7802a2f2..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedApplicationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason_code** | **str** | Indicates the reason why a request succeeded or failed and possible action to take if a request fails. For details, see the appendix of reason codes in the documentation for the relevant payment method. | [optional] -**r_code** | **str** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional] -**r_flag** | **str** | One-word description of the result of the application. | [optional] -**applications** | [**list[TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications]**](TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md) | | [optional] -**return_code** | **int** | The description for this field is not available. | [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/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md b/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md deleted file mode 100644 index d3bb28fd..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md +++ /dev/null @@ -1,18 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the CyberSource transaction type (such as CC settlement or CC authorization) that the merchant wants to process in a transaction request. More than one transaction type can included in a transaction request. Each transaction type separately returns their own status, reasonCode, rCode, and rFlag messages. | [optional] -**reason_code** | **str** | 3-digit reason code that indicates why the customer profile payment succeeded or failed. | [optional] -**status** | **str** | The status of the submitted transaction. Note: This field may not be returned for all transactions. | [optional] -**reason** | **str** | Description of why a request failed. Note: This field may not be returned for all transactions. | [optional] -**r_code** | **str** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional] -**r_flag** | **str** | One-word description of the result of the application. | [optional] -**reconciliation_id** | **str** | Reference number that you use to reconcile your CyberSource reports with your processor reports. | [optional] -**r_message** | **str** | Message that explains the reply flag for the application. | [optional] -**return_code** | **int** | The description for this field is not available. | [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/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md deleted file mode 100644 index 263efc80..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | 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] -**application_name** | **str** | 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] -**application_user** | **str** | 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. | [optional] -**partner** | [**TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner**](TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.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/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md deleted file mode 100644 index c828f209..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**solution_id** | **str** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [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/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md deleted file mode 100644 index 2eb96f4b..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**xid** | **str** | Transaction identifier. | [optional] -**transaction_id** | **str** | Payer auth Transaction identifier. | [optional] -**eci_raw** | **str** | 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/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md deleted file mode 100644 index 985519f9..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedErrorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | Description of why a request failed. Note: This field may not be returned for all 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/TssV2TransactionsPost201ResponseEmbeddedLinks.md b/docs/TssV2TransactionsPost201ResponseEmbeddedLinks.md deleted file mode 100644 index ff124501..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedLinks.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction_detail** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.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/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md deleted file mode 100644 index 08490716..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reseller_id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] - -[[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/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md deleted file mode 100644 index 48ec09dc..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bill_to** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo**](TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md) | | [optional] -**ship_to** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo**](TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md) | | [optional] -**amount_details** | [**Ptsv2paymentsidreversalsReversalInformationAmountDetails**](Ptsv2paymentsidreversalsReversalInformationAmountDetails.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/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md deleted file mode 100644 index 00743f2f..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md +++ /dev/null @@ -1,15 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**first_name** | **str** | 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] -**last_name** | **str** | 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** | **str** | 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** | **str** | 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** | **str** | 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] -**phone_number** | **str** | 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/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md deleted file mode 100644 index d29034da..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**phone_number** | **str** | Phone number associated with the shipping 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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md deleted file mode 100644 index ce93c8bb..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_type** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md) | | [optional] -**customer** | [**Ptsv2refreshpaymentstatusidPaymentInformationCustomer**](Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md) | | [optional] -**card** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md) | | [optional] -**bank** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.md deleted file mode 100644 index 4c4fddc0..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.md deleted file mode 100644 index 78cfd686..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**suffix** | **str** | Last four digits of the customer's payment account number. | [optional] -**prefix** | **str** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. | [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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md deleted file mode 100644 index f70112b8..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**suffix** | **str** | Last four digits of the cardholder's account number. This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### PIN debit This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. Returned by PIN debit credit and PIN debit purchase. This field is supported only by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional] -**prefix** | **str** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] -**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md deleted file mode 100644 index 5b28c236..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md +++ /dev/null @@ -1,11 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | Indicates the payment type used in this payment transaction. Example: credit card, check | [optional] -**method** | **str** | Indicates the payment method used in this payment 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/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md deleted file mode 100644 index 203adbc2..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminal_id** | **str** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional] -**terminal_serial_number** | **str** | Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional] -**device_id** | **str** | Value created by the client software that uniquely identifies the POS device. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only for authorizations and credits on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field. String (32) | [optional] -**partner** | [**TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner**](TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md) | | [optional] -**emv** | [**Ptsv2paymentsidreversalsPointOfSaleInformationEmv**](Ptsv2paymentsidreversalsPointOfSaleInformationEmv.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/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md deleted file mode 100644 index 2923c9ad..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**original_transaction_id** | **str** | Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal's software and to CyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's software. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. | [optional] - -[[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/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md deleted file mode 100644 index d11b8cfa..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] -**business_application_id** | **str** | Required for AFT and OCT transactions. Given below is a list of all the BAI values available. However, the processors may support only few specific BAI values. - AA : Account-to-account - BB : Supplier Payments - BI : Bank-Initiated P2P Money Transfer - BP : Non-Card Bill Pay/Bill Pay - CD : Cash Deposit - CP : Credit card Bill Payment - FD : Funds disbursement - FT : Funds transfer - GD : Government Disbursement - GP : Gambling payout (non-online gambling) - LO : Loyalty credits and rebates - MD : Merchant Settlement - OG : Online Gambling Payout - PD : Payroll and pension disbursement - PP : Person-to-Person or Peer-to-Peer - TU : Top up, prepaid load - WT : Digital wallet | [optional] -**commerce_indicator** | **str** | 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] -**commerce_indicator_label** | **str** | 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/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md deleted file mode 100644 index c1362de9..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedProcessorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**processor** | [**TssV2TransactionsGet200ResponseProcessorInformationProcessor**](TssV2TransactionsGet200ResponseProcessorInformationProcessor.md) | | [optional] -**provider_transaction_id** | **str** | Unique ID [codigo] generated by the processor for real-time payments processed directly by the Iugu processor. | [optional] -**approval_code** | **str** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional] -**event_status** | **str** | The event status. | [optional] -**retrieval_reference_number** | **str** | #### Ingenico ePayments Unique number that CyberSource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report. ### CyberSource through VisaNet Retrieval request number. | [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/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md deleted file mode 100644 index a74145be..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedRiskInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**providers** | [**TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders**](TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.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/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.md b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.md deleted file mode 100644 index 233b2cbe..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.md +++ /dev/null @@ -1,10 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fingerprint** | [**TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint**](TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.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/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md deleted file mode 100644 index 64272039..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md +++ /dev/null @@ -1,12 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**true_ipaddress** | **str** | Customer's true IP address detected by the application. For details, see the `true_ipaddress` field description in _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). | [optional] -**hash** | **str** | The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field. For more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). | [optional] -**smart_id** | **str** | The device identifier generated from attributes collected during profiling. Returned by a 3rd party when you use device fingerprinting. For details, see the `device_fingerprint_smart_id` field description in [CyberSource Decision Manager Device Fingerprinting Guide.](https://www.cybersource.com/developers/documentation/fraud_management) | [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/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md b/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md deleted file mode 100644 index ce24ca40..00000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md +++ /dev/null @@ -1,29 +0,0 @@ -# TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**merchant_id** | **str** | Your CyberSource merchant ID. | [optional] -**status** | **str** | The status of the submitted transaction. Note: This field may not be returned for all transactions. | [optional] -**application_information** | [**TssV2TransactionsPost201ResponseEmbeddedApplicationInformation**](TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md) | | [optional] -**buyer_information** | [**PtsV2CreateOrderPost201ResponseBuyerInformation**](PtsV2CreateOrderPost201ResponseBuyerInformation.md) | | [optional] -**client_reference_information** | [**TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation**](TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md) | | [optional] -**consumer_authentication_information** | [**TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation**](TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md) | | [optional] -**device_information** | [**Riskv1authenticationresultsDeviceInformation**](Riskv1authenticationresultsDeviceInformation.md) | | [optional] -**error_information** | [**TssV2TransactionsPost201ResponseEmbeddedErrorInformation**](TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md) | | [optional] -**fraud_marking_information** | [**TssV2TransactionsGet200ResponseFraudMarkingInformation**](TssV2TransactionsGet200ResponseFraudMarkingInformation.md) | | [optional] -**merchant_defined_information** | [**list[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] -**merchant_information** | [**TssV2TransactionsPost201ResponseEmbeddedMerchantInformation**](TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md) | | [optional] -**order_information** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformation**](TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md) | | [optional] -**payment_information** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformation**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md) | | [optional] -**processing_information** | [**TssV2TransactionsPost201ResponseEmbeddedProcessingInformation**](TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md) | | [optional] -**processor_information** | [**TssV2TransactionsPost201ResponseEmbeddedProcessorInformation**](TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md) | | [optional] -**point_of_sale_information** | [**TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation**](TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md) | | [optional] -**risk_information** | [**TssV2TransactionsPost201ResponseEmbeddedRiskInformation**](TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md) | | [optional] -**links** | [**TssV2TransactionsPost201ResponseEmbeddedLinks**](TssV2TransactionsPost201ResponseEmbeddedLinks.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/Tssv2transactionsemvTagDetailsEmvDetailsList.md b/docs/Tssv2transactionsemvTagDetailsEmvDetailsList.md deleted file mode 100644 index 4f554e60..00000000 --- a/docs/Tssv2transactionsemvTagDetailsEmvDetailsList.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tssv2transactionsemvTagDetailsEmvDetailsList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | -**emv_request_combined_tags** | **str** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) For Mastercard Transactions, Optionally Tag 9F60 (Authenticated Application Data) and Tag 96 (Kernel Identifier - Terminal) can be included in the Field. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): 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/UmsV1UsersGet200Response.md b/docs/UmsV1UsersGet200Response.md deleted file mode 100644 index 4ea1caa9..00000000 --- a/docs/UmsV1UsersGet200Response.md +++ /dev/null @@ -1,10 +0,0 @@ -# UmsV1UsersGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**users** | [**list[UmsV1UsersGet200ResponseUsers]**](UmsV1UsersGet200ResponseUsers.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/UmsV1UsersGet200ResponseAccountInformation.md b/docs/UmsV1UsersGet200ResponseAccountInformation.md deleted file mode 100644 index 607cc431..00000000 --- a/docs/UmsV1UsersGet200ResponseAccountInformation.md +++ /dev/null @@ -1,17 +0,0 @@ -# UmsV1UsersGet200ResponseAccountInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user_name** | **str** | | [optional] -**role_id** | **str** | | [optional] -**permissions** | **list[str]** | | [optional] -**status** | **str** | Valid values: - active - inactive - locked - disabled - forgotpassword - deleted | [optional] -**created_time** | **datetime** | | [optional] -**last_access_time** | **datetime** | | [optional] -**language_preference** | **str** | | [optional] -**timezone** | **str** | | [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/UmsV1UsersGet200ResponseContactInformation.md b/docs/UmsV1UsersGet200ResponseContactInformation.md deleted file mode 100644 index f4c6af63..00000000 --- a/docs/UmsV1UsersGet200ResponseContactInformation.md +++ /dev/null @@ -1,13 +0,0 @@ -# UmsV1UsersGet200ResponseContactInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **str** | | [optional] -**phone_number** | **str** | | [optional] -**first_name** | **str** | | [optional] -**last_name** | **str** | | [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/UmsV1UsersGet200ResponseOrganizationInformation.md b/docs/UmsV1UsersGet200ResponseOrganizationInformation.md deleted file mode 100644 index c0456de5..00000000 --- a/docs/UmsV1UsersGet200ResponseOrganizationInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# UmsV1UsersGet200ResponseOrganizationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organization_id** | **str** | | [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/UmsV1UsersGet200ResponseUsers.md b/docs/UmsV1UsersGet200ResponseUsers.md deleted file mode 100644 index cdeb1b75..00000000 --- a/docs/UmsV1UsersGet200ResponseUsers.md +++ /dev/null @@ -1,13 +0,0 @@ -# UmsV1UsersGet200ResponseUsers - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_information** | [**UmsV1UsersGet200ResponseAccountInformation**](UmsV1UsersGet200ResponseAccountInformation.md) | | [optional] -**organization_information** | [**UmsV1UsersGet200ResponseOrganizationInformation**](UmsV1UsersGet200ResponseOrganizationInformation.md) | | [optional] -**contact_information** | [**UmsV1UsersGet200ResponseContactInformation**](UmsV1UsersGet200ResponseContactInformation.md) | | [optional] -**custom_fields** | **dict(str, str)** | | [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/UnauthorizedClientError.md b/docs/UnauthorizedClientError.md deleted file mode 100644 index ad201f61..00000000 --- a/docs/UnauthorizedClientError.md +++ /dev/null @@ -1,11 +0,0 @@ -# UnauthorizedClientError - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | **str** | | [optional] -**error_description** | **str** | | [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/UnifiedCheckoutCaptureContextApi.md b/docs/UnifiedCheckoutCaptureContextApi.md deleted file mode 100644 index 5a95a478..00000000 --- a/docs/UnifiedCheckoutCaptureContextApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# CyberSource.UnifiedCheckoutCaptureContextApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**generate_unified_checkout_capture_context**](UnifiedCheckoutCaptureContextApi.md#generate_unified_checkout_capture_context) | **POST** /up/v1/capture-contexts | Generate Unified Checkout Capture Context - - -# **generate_unified_checkout_capture_context** -> str generate_unified_checkout_capture_context(generate_unified_checkout_capture_context_request) - -Generate Unified Checkout Capture Context - -Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.UnifiedCheckoutCaptureContextApi() -generate_unified_checkout_capture_context_request = CyberSource.GenerateUnifiedCheckoutCaptureContextRequest() # GenerateUnifiedCheckoutCaptureContextRequest | - -try: - # Generate Unified Checkout Capture Context - api_response = api_instance.generate_unified_checkout_capture_context(generate_unified_checkout_capture_context_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling UnifiedCheckoutCaptureContextApi->generate_unified_checkout_capture_context: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **generate_unified_checkout_capture_context_request** | [**GenerateUnifiedCheckoutCaptureContextRequest**](GenerateUnifiedCheckoutCaptureContextRequest.md)| | - -### Return type - -**str** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/jwt - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/UpdateInvoiceRequest.md b/docs/UpdateInvoiceRequest.md deleted file mode 100644 index fdbb4d56..00000000 --- a/docs/UpdateInvoiceRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# UpdateInvoiceRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_information** | [**Invoicingv2invoicesCustomerInformation**](Invoicingv2invoicesCustomerInformation.md) | | [optional] -**processing_information** | [**Invoicingv2invoicesProcessingInformation**](Invoicingv2invoicesProcessingInformation.md) | | [optional] -**invoice_information** | [**Invoicingv2invoicesidInvoiceInformation**](Invoicingv2invoicesidInvoiceInformation.md) | | -**order_information** | [**Invoicingv2invoicesOrderInformation**](Invoicingv2invoicesOrderInformation.md) | | - -[[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/UpdateOrderRequest.md b/docs/UpdateOrderRequest.md deleted file mode 100644 index 854f7b7c..00000000 --- a/docs/UpdateOrderRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# UpdateOrderRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Ptsv2intentsClientReferenceInformation**](Ptsv2intentsClientReferenceInformation.md) | | [optional] -**order_information** | [**Ptsv2intentsidOrderInformation**](Ptsv2intentsidOrderInformation.md) | | [optional] -**merchant_information** | [**Ptsv2intentsidMerchantInformation**](Ptsv2intentsidMerchantInformation.md) | | [optional] -**payment_information** | [**Ptsv2intentsidPaymentInformation**](Ptsv2intentsidPaymentInformation.md) | | [optional] -**processing_information** | [**Ptsv2intentsidProcessingInformation**](Ptsv2intentsidProcessingInformation.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/UpdatePaymentLinkRequest.md b/docs/UpdatePaymentLinkRequest.md deleted file mode 100644 index c4ef3978..00000000 --- a/docs/UpdatePaymentLinkRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# UpdatePaymentLinkRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **str** | The status of the purchase or donation link. Possible values: - ACTIVE - INACTIVE | [optional] -**client_reference_information** | [**Invoicingv2invoicesClientReferenceInformation**](Invoicingv2invoicesClientReferenceInformation.md) | | [optional] -**processing_information** | [**Iplv2paymentlinksidProcessingInformation**](Iplv2paymentlinksidProcessingInformation.md) | | [optional] -**purchase_information** | [**Iplv2paymentlinksidPurchaseInformation**](Iplv2paymentlinksidPurchaseInformation.md) | | [optional] -**order_information** | [**Iplv2paymentlinksidOrderInformation**](Iplv2paymentlinksidOrderInformation.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/UpdatePlanRequest.md b/docs/UpdatePlanRequest.md deleted file mode 100644 index 30ee7e67..00000000 --- a/docs/UpdatePlanRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# UpdatePlanRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**plan_information** | [**Rbsv1plansidPlanInformation**](Rbsv1plansidPlanInformation.md) | | [optional] -**processing_information** | [**Rbsv1plansidProcessingInformation**](Rbsv1plansidProcessingInformation.md) | | [optional] -**order_information** | [**GetAllPlansResponseOrderInformation**](GetAllPlansResponseOrderInformation.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/UpdatePlanResponse.md b/docs/UpdatePlanResponse.md deleted file mode 100644 index b4e5cd1e..00000000 --- a/docs/UpdatePlanResponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# UpdatePlanResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - COMPLETED | [optional] -**plan_information** | [**UpdatePlanResponsePlanInformation**](UpdatePlanResponsePlanInformation.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/UpdatePlanResponsePlanInformation.md b/docs/UpdatePlanResponsePlanInformation.md deleted file mode 100644 index 9d14dfcb..00000000 --- a/docs/UpdatePlanResponsePlanInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# UpdatePlanResponsePlanInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Plan code | [optional] -**status** | **str** | Plan Status: - `DRAFT` - `ACTIVE` - `INACTIVE` | [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/UpdateStatus.md b/docs/UpdateStatus.md deleted file mode 100644 index f141e189..00000000 --- a/docs/UpdateStatus.md +++ /dev/null @@ -1,10 +0,0 @@ -# UpdateStatus - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **str** | The status the user intends to update the subscription to. The supported values are ACTIVE & INACTIVE. If the subscription status is INACTIVE, webhook notifications will not be sent. Webhooks will resume being sent once the subscription is ACTIVE again. Possible values: - ACTIVE - INACTIVE | [optional] [default to 'INACTIVE'] - -[[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/UpdateSubscription.md b/docs/UpdateSubscription.md deleted file mode 100644 index 7ec003eb..00000000 --- a/docs/UpdateSubscription.md +++ /dev/null @@ -1,14 +0,0 @@ -# UpdateSubscription - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Rbsv1subscriptionsClientReferenceInformation**](Rbsv1subscriptionsClientReferenceInformation.md) | | [optional] -**processing_information** | [**Rbsv1subscriptionsProcessingInformation**](Rbsv1subscriptionsProcessingInformation.md) | | [optional] -**plan_information** | [**Rbsv1subscriptionsidPlanInformation**](Rbsv1subscriptionsidPlanInformation.md) | | [optional] -**subscription_information** | [**Rbsv1subscriptionsidSubscriptionInformation**](Rbsv1subscriptionsidSubscriptionInformation.md) | | [optional] -**order_information** | [**Rbsv1subscriptionsidOrderInformation**](Rbsv1subscriptionsidOrderInformation.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/UpdateSubscriptionResponse.md b/docs/UpdateSubscriptionResponse.md deleted file mode 100644 index 70980b86..00000000 --- a/docs/UpdateSubscriptionResponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# UpdateSubscriptionResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**GetAllSubscriptionsResponseLinks**](GetAllSubscriptionsResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - COMPLETED - PENDING_REVIEW - DECLINED - INVALID_REQUEST | [optional] -**subscription_information** | [**CreateSubscriptionResponseSubscriptionInformation**](CreateSubscriptionResponseSubscriptionInformation.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/UpdateWebhook.md b/docs/UpdateWebhook.md deleted file mode 100644 index d4f7f788..00000000 --- a/docs/UpdateWebhook.md +++ /dev/null @@ -1,17 +0,0 @@ -# UpdateWebhook - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Client friendly webhook name. | [optional] -**organization_id** | **str** | Organization Id. | [optional] -**description** | **str** | Client friendly webhook description. | [optional] -**products** | [**list[Notificationsubscriptionsv2webhooksProducts]**](Notificationsubscriptionsv2webhooksProducts.md) | | [optional] -**webhook_url** | **str** | The client's endpoint (URL) to receive webhooks. | [optional] -**notification_scope** | **str** | The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. This field is optional. Possible values: - SELF - DESCENDANTS | [optional] [default to 'DESCENDANTS'] -**health_check_url** | **str** | The client's health check endpoint (URL). | [optional] -**security_policy** | [**Notificationsubscriptionsv2webhooksSecurityPolicy**](Notificationsubscriptionsv2webhooksSecurityPolicy.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/Upv1capturecontextsCaptureMandate.md b/docs/Upv1capturecontextsCaptureMandate.md deleted file mode 100644 index 61caa199..00000000 --- a/docs/Upv1capturecontextsCaptureMandate.md +++ /dev/null @@ -1,19 +0,0 @@ -# Upv1capturecontextsCaptureMandate - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**billing_type** | **str** | Configure Unified Checkout to capture billing address information. Possible values: - FULL: Capture complete billing address information. - PARTIAL: Capture first name, last name, country and postal/zip code only. - NONE: Capture only first name and last name. | [optional] -**request_email** | **bool** | Configure Unified Checkout to capture customer email address. Possible values: - True - False | [optional] -**request_phone** | **bool** | Configure Unified Checkout to capture customer phone number. Possible values: - True - False | [optional] -**request_shipping** | **bool** | Configure Unified Checkout to capture customer shipping details. Possible values: - True - False | [optional] -**ship_to_countries** | **list[str]** | List of countries available to ship to. Use the two-character ISO Standard Country Codes. | [optional] -**show_accepted_network_icons** | **bool** | Configure Unified Checkout to display the list of accepted card networks beneath the payment button Possible values: - True - False | [optional] -**show_confirmation_step** | **bool** | Configure Unified Checkout to display the final confirmation screen when using Click to Pay.<br> Where 'BillingType'= NONE and 'requestShipping'= FALSE and the customer is using an existing Click to Pay card as their chosen payment method, a final confirmation screen can be removed allowing the customer to check out as soon as they have selected their payment method from within their Click to Pay card tray. Possible values: - True - False | [optional] -**request_save_card** | **bool** | Configure Unified Checkout to display the \"Save card for future use\" checkbox.<br> Configurable check box that will show in a Manual card entry flow to allow a Cardholder to give consent to store their manually entered credential with the Merchant that they are paying.<br> Applicable when manually entering the details and not enrolling in Click to Pay. Possible values: - True - False<br><br> **Use Cases:** **Offer consumers option to save their card in Unified Checkout:** - Include the captureMandate.requestSaveCard field in the capture context request and set it to true. - When set to true, this will show a checkbox with the message 'Save card for future use' in Unified Checkout. - When selected this provides a response in both the Transient Token and Get Credentials API response.<br><br> **Do not offer consumers the option to save their card in Unified Checkout:** - Include the captureMandate.requestSaveCard field in the capture context request and set it to false OR omit the field from the capture context request. - When set to false, the save card option is not shown to consumers when manually entering card details. | [optional] -**combo_card** | **bool** | Configure Unified Checkout to display combo card at checkout.<br> A combo debit/credit card is a single card that functions both as a Debit/Credit card. Unified Checkout / Click to Pay Drop-in UI allows the Cardholder to choose whether they would like the transaction to be paid for using either debit or credit card. **Important:** This is applicable to Visa cards only. Possible values: - True - False<br><br> **Use Cases:** **Offer Combo Card at Checkout:** - Include the captureMandate.comboCard field in the capture context request and set it to true. - When set to true, Combo Card selection is shown at checkout <br><br> **Do not offer Combo Card at Checkout:** - Include the captureMandate.comboCard field in the capture context request and set it to false OR omit the field from the capture context request. - The Combo Card selection is not shown at checkout. | [optional] -**cpf** | **bool** | Configure Unified Checkout to display and capture the CPF number (Cadastro de Pessoas Físicas). The CPF number is a unique 11-digit identifier issued to Brazilian citizens and residents for tax purposes. Possible values: - True - False<br><br> This field is optional. If set to true the field is required. If set to false the field is optional. If the field is not included in the capture context then it is not captured.<br><br> **Important:** - If PANENTRY is specified in the allowedPaymentTypes field, the CPF number will be displayed in Unified Checkout regardless of what card number is entered. - If CLICKTOPAY is specified in the allowedPaymentTypes field, the CPF number will be displayed in Unified Checkout only when a Visa Click To Pay card is entered. | [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/Upv1capturecontextsCompleteMandate.md b/docs/Upv1capturecontextsCompleteMandate.md deleted file mode 100644 index 8fddd15e..00000000 --- a/docs/Upv1capturecontextsCompleteMandate.md +++ /dev/null @@ -1,12 +0,0 @@ -# Upv1capturecontextsCompleteMandate - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | This field is used to indicate how a payment should be processed. Possible values: - AUTH: Use this value when you want to authorize a payment within Unified Checkout without capturing it immediately. Payment types that initiate an immediate transfer of funds are NOT allowed. If a capture context request includes a payment type incompatible with this mode, a 400 error will be returned. A merchant would need to perform their own capture via API where applicable.<br><br> - CAPTURE: Use this value when you want to perform a sale within Unified Checkout and capture the payment immediately during the transaction. Note: Some payment types may return a PENDING status, requiring an additional status check call to determine the final outcome of the payment.<br><br> - PREFER_AUTH: Use this value to offer multiple alternative payment options during the Unified Checkout experience. This option authorizes the payment without immediate capture, where available. It will perform a \"CAPTURE\" where an \"AUTH\" is not allowed by the payment type. Transactions can be AUTHORIZED, CAPTURED, or PENDING. If an \"AUTH\" is performed, a merchant would need to perform their own capture via API where applicable. | [optional] -**decision_manager** | **bool** | Configure Unified Checkout to determine whether Decision Manager is invoked during service orchestration. Possible values: - True - False<br><br> Setting this value to True indicates that device fingerprinting will be executed to add additional information for risk service Setting this value to False (or not provided) indicates that you do not wish to run device fingerprinting and skip decision manager services. | [optional] -**consumer_authentication** | **bool** | Configure Unified Checkout to determine whether Consumer Authentication is invoked during service orchestration. Possible values: - True - False<br><br> Setting this value to True will attempt to perform authentication using the Payer Authentication Service. Setting this value to False (or not provided) indicates that you do not wish to perform authentication using the Payer Authentication 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/Upv1capturecontextsOrderInformation.md b/docs/Upv1capturecontextsOrderInformation.md deleted file mode 100644 index 65de4e5c..00000000 --- a/docs/Upv1capturecontextsOrderInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Upv1capturecontextsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_details** | [**Upv1capturecontextsOrderInformationAmountDetails**](Upv1capturecontextsOrderInformationAmountDetails.md) | | [optional] -**bill_to** | [**Upv1capturecontextsOrderInformationBillTo**](Upv1capturecontextsOrderInformationBillTo.md) | | [optional] -**ship_to** | [**Upv1capturecontextsOrderInformationShipTo**](Upv1capturecontextsOrderInformationShipTo.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/Upv1capturecontextsOrderInformationAmountDetails.md b/docs/Upv1capturecontextsOrderInformationAmountDetails.md deleted file mode 100644 index 8e055022..00000000 --- a/docs/Upv1capturecontextsOrderInformationAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# Upv1capturecontextsOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_amount** | **str** | This field defines the total order amount. | [optional] -**currency** | **str** | This field defines the currency applicable 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/Upv1capturecontextsOrderInformationBillTo.md b/docs/Upv1capturecontextsOrderInformationBillTo.md deleted file mode 100644 index 68236824..00000000 --- a/docs/Upv1capturecontextsOrderInformationBillTo.md +++ /dev/null @@ -1,28 +0,0 @@ -# Upv1capturecontextsOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] -**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. | [optional] -**address3** | **str** | Additional address information (third line of the billing address) | [optional] -**address4** | **str** | Additional address information (fourth line of the billing address) | [optional] -**administrative_area** | **str** | 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). | [optional] -**building_number** | **str** | Building number in the street address. | [optional] -**country** | **str** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). | [optional] -**district** | **str** | Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality | [optional] -**locality** | **str** | Payment card billing city. | [optional] -**postal_code** | **str** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. | [optional] -**company** | [**Upv1capturecontextsOrderInformationBillToCompany**](Upv1capturecontextsOrderInformationBillToCompany.md) | | [optional] -**email** | **str** | Customer's email address, including the full domain name. | [optional] -**first_name** | **str** | Customer's first name. This name must be the same as the name on the card | [optional] -**last_name** | **str** | Customer's last name. This name must be the same as the name on the card. | [optional] -**middle_name** | **str** | Customer's middle name. | [optional] -**name_suffix** | **str** | Customer's name suffix. | [optional] -**title** | **str** | Title. | [optional] -**phone_number** | **str** | Customer's phone number. | [optional] -**phone_type** | **str** | Customer's phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work | [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/Upv1capturecontextsOrderInformationBillToCompany.md b/docs/Upv1capturecontextsOrderInformationBillToCompany.md deleted file mode 100644 index 7fc4fa23..00000000 --- a/docs/Upv1capturecontextsOrderInformationBillToCompany.md +++ /dev/null @@ -1,20 +0,0 @@ -# Upv1capturecontextsOrderInformationBillToCompany - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the customer's company. | [optional] -**address1** | **str** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] -**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. | [optional] -**address3** | **str** | Additional address information (third line of the billing address) | [optional] -**address4** | **str** | Additional address information (fourth line of the billing address) | [optional] -**administrative_area** | **str** | 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). | [optional] -**building_number** | **str** | Building number in the street address. | [optional] -**country** | **str** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). | [optional] -**district** | **str** | Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality | [optional] -**locality** | **str** | Payment card billing city. | [optional] -**postal_code** | **str** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. | [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/Upv1capturecontextsOrderInformationShipTo.md b/docs/Upv1capturecontextsOrderInformationShipTo.md deleted file mode 100644 index c6259ac9..00000000 --- a/docs/Upv1capturecontextsOrderInformationShipTo.md +++ /dev/null @@ -1,21 +0,0 @@ -# Upv1capturecontextsOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | First line of the shipping address. | [optional] -**address2** | **str** | Second line of the shipping address. | [optional] -**address3** | **str** | Third line of the shipping address. | [optional] -**address4** | **str** | Fourth line of the shipping address. | [optional] -**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) | [optional] -**building_number** | **str** | Building number in the street address. | [optional] -**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) | [optional] -**district** | **str** | Neighborhood, community, or region within a city or municipality. | [optional] -**locality** | **str** | City of the shipping address. | [optional] -**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. | [optional] -**first_name** | **str** | First name of the recipient | [optional] -**last_name** | **str** | Last name of the recipient. | [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/UserManagementApi.md b/docs/UserManagementApi.md deleted file mode 100644 index 71649150..00000000 --- a/docs/UserManagementApi.md +++ /dev/null @@ -1,63 +0,0 @@ -# CyberSource.UserManagementApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_users**](UserManagementApi.md#get_users) | **GET** /ums/v1/users | Get User Information - Deprecated - - -# **get_users** -> UmsV1UsersGet200Response get_users(organization_id=organization_id, user_name=user_name, permission_id=permission_id, role_id=role_id) - -Get User Information - Deprecated - -This endpoint is deprecated. Please use the search end point. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.UserManagementApi() -organization_id = 'organization_id_example' # str | This is the orgId of the organization which the user belongs to. (optional) -user_name = 'user_name_example' # str | User ID of the user you want to get details on. (optional) -permission_id = 'permission_id_example' # str | permission that you are trying to search user on. (optional) -role_id = 'role_id_example' # str | role of the user you are trying to search on. (optional) - -try: - # Get User Information - Deprecated - api_response = api_instance.get_users(organization_id=organization_id, user_name=user_name, permission_id=permission_id, role_id=role_id) - pprint(api_response) -except ApiException as e: - print("Exception when calling UserManagementApi->get_users: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organization_id** | **str**| This is the orgId of the organization which the user belongs to. | [optional] - **user_name** | **str**| User ID of the user you want to get details on. | [optional] - **permission_id** | **str**| permission that you are trying to search user on. | [optional] - **role_id** | **str**| role of the user you are trying to search on. | [optional] - -### Return type - -[**UmsV1UsersGet200Response**](UmsV1UsersGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/UserManagementSearchApi.md b/docs/UserManagementSearchApi.md deleted file mode 100644 index 073760fb..00000000 --- a/docs/UserManagementSearchApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# CyberSource.UserManagementSearchApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**search_users**](UserManagementSearchApi.md#search_users) | **POST** /ums/v1/users/search | Search User Information - - -# **search_users** -> UmsV1UsersGet200Response search_users(search_request) - -Search User Information - -This endpoint is to get all the user information depending on the filter criteria passed in request body. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.UserManagementSearchApi() -search_request = CyberSource.SearchRequest() # SearchRequest | - -try: - # Search User Information - api_response = api_instance.search_users(search_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling UserManagementSearchApi->search_users: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **search_request** | [**SearchRequest**](SearchRequest.md)| | - -### Return type - -[**UmsV1UsersGet200Response**](UmsV1UsersGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/V1FileDetailsGet200Response.md b/docs/V1FileDetailsGet200Response.md deleted file mode 100644 index e5d12a11..00000000 --- a/docs/V1FileDetailsGet200Response.md +++ /dev/null @@ -1,11 +0,0 @@ -# V1FileDetailsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file_details** | [**list[V1FileDetailsGet200ResponseFileDetails]**](V1FileDetailsGet200ResponseFileDetails.md) | | [optional] -**links** | [**V1FileDetailsGet200ResponseLinks**](V1FileDetailsGet200ResponseLinks.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/V1FileDetailsGet200ResponseFileDetails.md b/docs/V1FileDetailsGet200ResponseFileDetails.md deleted file mode 100644 index 60357ca8..00000000 --- a/docs/V1FileDetailsGet200ResponseFileDetails.md +++ /dev/null @@ -1,16 +0,0 @@ -# V1FileDetailsGet200ResponseFileDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file_id** | **str** | Unique identifier of a file | [optional] -**name** | **str** | Name of the file | [optional] -**created_time** | **datetime** | Date and time for the file in PST | [optional] -**last_modified_time** | **datetime** | Date and time for the file in PST | [optional] -**_date** | **date** | Date and time for the file in PST | [optional] -**mime_type** | **str** | 'File extension' Valid values: - 'application/xml' - 'text/csv' - 'application/pdf' - 'application/octet-stream' | [optional] -**size** | **float** | Size of the file in bytes | [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/V1FileDetailsGet200ResponseLinks.md b/docs/V1FileDetailsGet200ResponseLinks.md deleted file mode 100644 index 7989a1d2..00000000 --- a/docs/V1FileDetailsGet200ResponseLinks.md +++ /dev/null @@ -1,11 +0,0 @@ -# V1FileDetailsGet200ResponseLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_self** | [**V1FileDetailsGet200ResponseLinksSelf**](V1FileDetailsGet200ResponseLinksSelf.md) | | [optional] -**files** | [**list[V1FileDetailsGet200ResponseLinksFiles]**](V1FileDetailsGet200ResponseLinksFiles.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/V1FileDetailsGet200ResponseLinksFiles.md b/docs/V1FileDetailsGet200ResponseLinksFiles.md deleted file mode 100644 index d76d0e50..00000000 --- a/docs/V1FileDetailsGet200ResponseLinksFiles.md +++ /dev/null @@ -1,12 +0,0 @@ -# V1FileDetailsGet200ResponseLinksFiles - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file_id** | **str** | Unique identifier for each file | [optional] -**href** | **str** | | [optional] -**method** | **str** | | [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/V1FileDetailsGet200ResponseLinksSelf.md b/docs/V1FileDetailsGet200ResponseLinksSelf.md deleted file mode 100644 index 71211e8d..00000000 --- a/docs/V1FileDetailsGet200ResponseLinksSelf.md +++ /dev/null @@ -1,11 +0,0 @@ -# V1FileDetailsGet200ResponseLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **str** | | [optional] -**method** | **str** | | [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/VTConfig.md b/docs/VTConfig.md deleted file mode 100644 index 3db08350..00000000 --- a/docs/VTConfig.md +++ /dev/null @@ -1,11 +0,0 @@ -# VTConfig - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card_not_present** | [**VTConfigCardNotPresent**](VTConfigCardNotPresent.md) | | [optional] -**card_present** | [**VTConfigCardNotPresent**](VTConfigCardNotPresent.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/VTConfigCardNotPresent.md b/docs/VTConfigCardNotPresent.md deleted file mode 100644 index 5ece1e88..00000000 --- a/docs/VTConfigCardNotPresent.md +++ /dev/null @@ -1,11 +0,0 @@ -# VTConfigCardNotPresent - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**global_payment_information** | [**VTConfigCardNotPresentGlobalPaymentInformation**](VTConfigCardNotPresentGlobalPaymentInformation.md) | | [optional] -**receipt_information** | [**VTConfigCardNotPresentReceiptInformation**](VTConfigCardNotPresentReceiptInformation.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/VTConfigCardNotPresentGlobalPaymentInformation.md b/docs/VTConfigCardNotPresentGlobalPaymentInformation.md deleted file mode 100644 index 75c8d8a9..00000000 --- a/docs/VTConfigCardNotPresentGlobalPaymentInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# VTConfigCardNotPresentGlobalPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**basic_information** | [**VTConfigCardNotPresentGlobalPaymentInformationBasicInformation**](VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md) | | [optional] -**payment_information** | [**VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation**](VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md) | | [optional] -**merchant_defined_data_fields** | [**VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields**](VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.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/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md b/docs/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md deleted file mode 100644 index 470db890..00000000 --- a/docs/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md +++ /dev/null @@ -1,18 +0,0 @@ -# VTConfigCardNotPresentGlobalPaymentInformationBasicInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**default_standard_entry_class_code** | **str** | | [optional] -**default_country_code** | **str** | ISO 4217 format | [optional] -**default_currency_code** | **str** | Three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] -**default_transaction_type** | **str** | Possible values: - AUTHORIZATION - SALE | [optional] -**default_payment_type** | **str** | Possible values: - CREDIT_CARD - ECHECK | [optional] -**default_transaction_source** | **str** | | [optional] -**display_retail** | **bool** | | [optional] -**display_moto** | **bool** | | [optional] -**display_internet** | **bool** | | [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/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.md b/docs/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.md deleted file mode 100644 index 44778e0d..00000000 --- a/docs/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.md +++ /dev/null @@ -1,34 +0,0 @@ -# VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_merchant_defined_data1** | **bool** | | [optional] -**display_merchant_defined_data2** | **bool** | | [optional] -**display_merchant_defined_data3** | **bool** | | [optional] -**display_merchant_defined_data4** | **bool** | | [optional] -**display_merchant_defined_data5** | **bool** | | [optional] -**merchant_defined_data1_default_value** | **str** | | [optional] -**merchant_defined_data1_label** | **str** | | [optional] -**require_merchant_defined_data1** | **bool** | | [optional] -**merchant_defined_data2_default_value** | **str** | | [optional] -**merchant_defined_data2_label** | **str** | | [optional] -**require_merchant_defined_data2** | **bool** | | [optional] -**merchant_defined_data3_default_value** | **str** | | [optional] -**merchant_defined_data3_label** | **str** | | [optional] -**require_merchant_defined_data3** | **bool** | | [optional] -**merchant_defined_data4_default_value** | **str** | | [optional] -**merchant_defined_data4_label** | **str** | | [optional] -**require_merchant_defined_data4** | **bool** | | [optional] -**merchant_defined_data5_default_value** | **str** | | [optional] -**merchant_defined_data5_label** | **str** | | [optional] -**require_merchant_defined_data5** | **bool** | | [optional] -**merchant_defined_data1_display_on_receipt** | **bool** | | [optional] -**merchant_defined_data2_display_on_receipt** | **bool** | | [optional] -**merchant_defined_data3_display_on_receipt** | **bool** | | [optional] -**merchant_defined_data4_display_on_receipt** | **bool** | | [optional] -**merchant_defined_data5_display_on_receipt** | **bool** | | [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/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md b/docs/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md deleted file mode 100644 index 8a3d3294..00000000 --- a/docs/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md +++ /dev/null @@ -1,22 +0,0 @@ -# VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_card_verification_value** | **list[str]** | | [optional] -**require_card_verification_value** | **list[str]** | | [optional] -**accepted_card_types** | **list[str]** | | [optional] -**display_credit_cards** | **bool** | | [optional] -**display_echecks** | **bool** | | [optional] -**display_debt_indicator** | **bool** | | [optional] -**display_bill_payment** | **bool** | | [optional] -**enable_echecks** | **bool** | | [optional] -**display_ignore_e_check_avs_checkbox** | **bool** | | [optional] -**first_name_required** | **bool** | | [optional] -**last_name_required** | **bool** | | [optional] -**display_first_name** | **bool** | | [optional] -**display_last_name** | **bool** | | [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/VTConfigCardNotPresentReceiptInformation.md b/docs/VTConfigCardNotPresentReceiptInformation.md deleted file mode 100644 index a7a56623..00000000 --- a/docs/VTConfigCardNotPresentReceiptInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# VTConfigCardNotPresentReceiptInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**header** | [**VTConfigCardNotPresentReceiptInformationHeader**](VTConfigCardNotPresentReceiptInformationHeader.md) | | [optional] -**order_information** | [**VTConfigCardNotPresentReceiptInformationOrderInformation**](VTConfigCardNotPresentReceiptInformationOrderInformation.md) | | [optional] -**email_receipt** | [**VTConfigCardNotPresentReceiptInformationEmailReceipt**](VTConfigCardNotPresentReceiptInformationEmailReceipt.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/VTConfigCardNotPresentReceiptInformationEmailReceipt.md b/docs/VTConfigCardNotPresentReceiptInformationEmailReceipt.md deleted file mode 100644 index 8518d6c6..00000000 --- a/docs/VTConfigCardNotPresentReceiptInformationEmailReceipt.md +++ /dev/null @@ -1,10 +0,0 @@ -# VTConfigCardNotPresentReceiptInformationEmailReceipt - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**senders_email_address** | **str** | | [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/VTConfigCardNotPresentReceiptInformationHeader.md b/docs/VTConfigCardNotPresentReceiptInformationHeader.md deleted file mode 100644 index 71a536e1..00000000 --- a/docs/VTConfigCardNotPresentReceiptInformationHeader.md +++ /dev/null @@ -1,10 +0,0 @@ -# VTConfigCardNotPresentReceiptInformationHeader - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**virtual_terminal_receipt_header** | **str** | | [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/VTConfigCardNotPresentReceiptInformationOrderInformation.md b/docs/VTConfigCardNotPresentReceiptInformationOrderInformation.md deleted file mode 100644 index d5424e4e..00000000 --- a/docs/VTConfigCardNotPresentReceiptInformationOrderInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# VTConfigCardNotPresentReceiptInformationOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email_alias_name** | **str** | | [optional] -**custom_reply_to_email_address** | **str** | | [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/ValidateExportComplianceRequest.md b/docs/ValidateExportComplianceRequest.md deleted file mode 100644 index 095dd241..00000000 --- a/docs/ValidateExportComplianceRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# ValidateExportComplianceRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Riskv1liststypeentriesClientReferenceInformation**](Riskv1liststypeentriesClientReferenceInformation.md) | | [optional] -**order_information** | [**Riskv1exportcomplianceinquiriesOrderInformation**](Riskv1exportcomplianceinquiriesOrderInformation.md) | | [optional] -**buyer_information** | [**Riskv1addressverificationsBuyerInformation**](Riskv1addressverificationsBuyerInformation.md) | | [optional] -**device_information** | [**Riskv1exportcomplianceinquiriesDeviceInformation**](Riskv1exportcomplianceinquiriesDeviceInformation.md) | | [optional] -**export_compliance_information** | [**Riskv1exportcomplianceinquiriesExportComplianceInformation**](Riskv1exportcomplianceinquiriesExportComplianceInformation.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/ValidateRequest.md b/docs/ValidateRequest.md deleted file mode 100644 index 1ca0eb0a..00000000 --- a/docs/ValidateRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# ValidateRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Riskv1authenticationsetupsClientReferenceInformation**](Riskv1authenticationsetupsClientReferenceInformation.md) | | [optional] -**processing_information** | [**Riskv1authenticationsetupsProcessingInformation**](Riskv1authenticationsetupsProcessingInformation.md) | | [optional] -**order_information** | [**Riskv1authenticationresultsOrderInformation**](Riskv1authenticationresultsOrderInformation.md) | | [optional] -**payment_information** | [**Riskv1authenticationresultsPaymentInformation**](Riskv1authenticationresultsPaymentInformation.md) | | [optional] -**consumer_authentication_information** | [**Riskv1authenticationresultsConsumerAuthenticationInformation**](Riskv1authenticationresultsConsumerAuthenticationInformation.md) | | [optional] -**device_information** | [**Riskv1authenticationresultsDeviceInformation**](Riskv1authenticationresultsDeviceInformation.md) | | [optional] -**token_information** | [**Riskv1decisionsTokenInformation**](Riskv1decisionsTokenInformation.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/ValueAddedServicesProducts.md b/docs/ValueAddedServicesProducts.md deleted file mode 100644 index 58619077..00000000 --- a/docs/ValueAddedServicesProducts.md +++ /dev/null @@ -1,12 +0,0 @@ -# ValueAddedServicesProducts - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reporting** | [**PaymentsProductsTax**](PaymentsProductsTax.md) | | [optional] -**transaction_search** | [**PaymentsProductsTax**](PaymentsProductsTax.md) | | [optional] -**bank_account_validation** | [**PaymentsProductsTax**](PaymentsProductsTax.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/VasV2PaymentsPost201Response.md b/docs/VasV2PaymentsPost201Response.md deleted file mode 100644 index 07ce5b35..00000000 --- a/docs/VasV2PaymentsPost201Response.md +++ /dev/null @@ -1,16 +0,0 @@ -# VasV2PaymentsPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**VasV2PaymentsPost201ResponseLinks**](VasV2PaymentsPost201ResponseLinks.md) | | [optional] -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - COMPLETED | [optional] -**client_reference_information** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional] -**tax_information** | [**VasV2PaymentsPost201ResponseTaxInformation**](VasV2PaymentsPost201ResponseTaxInformation.md) | | [optional] -**order_information** | [**VasV2PaymentsPost201ResponseOrderInformation**](VasV2PaymentsPost201ResponseOrderInformation.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/VasV2PaymentsPost201ResponseLinks.md b/docs/VasV2PaymentsPost201ResponseLinks.md deleted file mode 100644 index ed434132..00000000 --- a/docs/VasV2PaymentsPost201ResponseLinks.md +++ /dev/null @@ -1,10 +0,0 @@ -# VasV2PaymentsPost201ResponseLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**void** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.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/VasV2PaymentsPost201ResponseOrderInformation.md b/docs/VasV2PaymentsPost201ResponseOrderInformation.md deleted file mode 100644 index 262635f8..00000000 --- a/docs/VasV2PaymentsPost201ResponseOrderInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# VasV2PaymentsPost201ResponseOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**exempt_amount** | **str** | Total amount of tax exempt amounts. This value is the sum of the values for all the `orderInformation.lineItems[].exemptAmount` fields in the tax calculation request. | [optional] -**taxable_amount** | **str** | Total amount of all taxable amounts. This value is the sum of the values for all the `orderInformation.lineItems[].taxAmount` fields in the tax calculation request. | [optional] -**tax_amount** | **str** | Total amount of tax for all lineItems in the tax calculation request. | [optional] -**line_items** | [**list[VasV2PaymentsPost201ResponseOrderInformationLineItems]**](VasV2PaymentsPost201ResponseOrderInformationLineItems.md) | | [optional] -**tax_details** | [**list[VasV2PaymentsPost201ResponseOrderInformationTaxDetails]**](VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md) | | [optional] -**amount_details** | [**Ptsv2paymentsidreversalsReversalInformationAmountDetails**](Ptsv2paymentsidreversalsReversalInformationAmountDetails.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/VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md b/docs/VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md deleted file mode 100644 index e585d971..00000000 --- a/docs/VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md +++ /dev/null @@ -1,18 +0,0 @@ -# VasV2PaymentsPost201ResponseOrderInformationJurisdiction - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | Type of tax jurisdiction for the item. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. Possible values: - `city` - `county` - `state` - `country` - `special` | [optional] -**tax_name** | **str** | Name of the jurisdiction tax for the item. For example, CA State Tax. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] -**tax_amount** | **str** | Jurisdiction tax amount for the item. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] -**taxable** | **str** | Jurisdiction taxable amount for the item, not including product level exemptions. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] -**name** | **str** | Free-text description of the jurisdiction for the item. For example, San Mateo County. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] -**code** | **str** | Jurisdiction code assigned by the tax provider. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] -**rate** | **str** | Jurisdiction tax rate for the item. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] -**region** | **str** | Free-text description of the jurisdiction region for the item. For example, CA (California State) or GB (Great Britain). Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] -**country** | **str** | Tax jurisdiction country for the item. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [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/VasV2PaymentsPost201ResponseOrderInformationLineItems.md b/docs/VasV2PaymentsPost201ResponseOrderInformationLineItems.md deleted file mode 100644 index c419e8af..00000000 --- a/docs/VasV2PaymentsPost201ResponseOrderInformationLineItems.md +++ /dev/null @@ -1,14 +0,0 @@ -# VasV2PaymentsPost201ResponseOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tax_details** | [**list[VasV2PaymentsPost201ResponseOrderInformationTaxDetails]**](VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md) | | [optional] -**jurisdiction** | [**list[VasV2PaymentsPost201ResponseOrderInformationJurisdiction]**](VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md) | | [optional] -**exempt_amount** | **str** | Exempt amount for the lineItem. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] -**taxable_amount** | **str** | Portion of the item amount that is taxable. | [optional] -**tax_amount** | **str** | Total tax for the item. This value is the sum of all taxes applied to the item. | [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/VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md b/docs/VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md deleted file mode 100644 index 5e285a13..00000000 --- a/docs/VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# VasV2PaymentsPost201ResponseOrderInformationTaxDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | Allowed tax types: - city - county - state - national - special | [optional] -**amount** | **str** | Amount corresponding to different types of taxes applied. | [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/VasV2PaymentsPost201ResponseTaxInformation.md b/docs/VasV2PaymentsPost201ResponseTaxInformation.md deleted file mode 100644 index d70b28f8..00000000 --- a/docs/VasV2PaymentsPost201ResponseTaxInformation.md +++ /dev/null @@ -1,11 +0,0 @@ -# VasV2PaymentsPost201ResponseTaxInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**commit_indicator** | **bool** | Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is \"Committed.\" For an uncommitted tax transaction, the status in the Tax Detail Report is \"Uncommitted.\" Possible values: - `true`: This is a committed tax transaction. - `false` (default): This is not a committed tax transaction. A committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed. The committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit. Use a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). | [optional] -**refund_indicator** | **bool** | Indicates whether this is a refund tax transaction. For a refund tax transaction, amounts in the Tax Detail Report will be negative. Possible values: - `true`: This is a refund tax transaction. - `false` (default): This is not a refund tax transaction. A refund tax request is a tax service request that sets the transaction type field in the Tax Detail Report to refunded and makes the reported amount negative. Tax amounts are returned as positive amounts in reply messages, but they are saved in reports as negative amounts which enables the reporting software to accurately calculate the aggregate amounts. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). | [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/VasV2PaymentsPost400Response.md b/docs/VasV2PaymentsPost400Response.md deleted file mode 100644 index 95ba7ab2..00000000 --- a/docs/VasV2PaymentsPost400Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# VasV2PaymentsPost400Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] -**reason** | **str** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - INVALID_MERCHANT_CONFIGURATION - INVALID_ADDRESS | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/VasV2TaxVoid200Response.md b/docs/VasV2TaxVoid200Response.md deleted file mode 100644 index 7eeda555..00000000 --- a/docs/VasV2TaxVoid200Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# VasV2TaxVoid200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - VOIDED - CANCELLED - FAILED | [optional] -**client_reference_information** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional] -**void_amount_details** | [**VasV2TaxVoid200ResponseVoidAmountDetails**](VasV2TaxVoid200ResponseVoidAmountDetails.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/VasV2TaxVoid200ResponseVoidAmountDetails.md b/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md deleted file mode 100644 index 44790f2f..00000000 --- a/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# VasV2TaxVoid200ResponseVoidAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**void_amount** | **str** | Total amount of the void. #### PIN Debit Amount of the reversal. Returned by PIN debit reversal. | [optional] -**currency** | **str** | 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/VasV2TaxVoidsPost400Response.md b/docs/VasV2TaxVoidsPost400Response.md deleted file mode 100644 index 02dc9424..00000000 --- a/docs/VasV2TaxVoidsPost400Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# VasV2TaxVoidsPost400Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] -**reason** | **str** | The reason of the status. Possible values: - INVALID_DATA - NOT_VOIDABLE | [optional] -**message** | **str** | The detail message related to the status and reason listed above. | [optional] -**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/Vasv2taxBuyerInformation.md b/docs/Vasv2taxBuyerInformation.md deleted file mode 100644 index 209b1e2b..00000000 --- a/docs/Vasv2taxBuyerInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Vasv2taxBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vat_registration_number** | **str** | 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/Vasv2taxClientReferenceInformation.md b/docs/Vasv2taxClientReferenceInformation.md deleted file mode 100644 index a5bc2d50..00000000 --- a/docs/Vasv2taxClientReferenceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Vasv2taxClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | 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** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] -**comments** | **str** | 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/Vasv2taxMerchantInformation.md b/docs/Vasv2taxMerchantInformation.md deleted file mode 100644 index 20fd7b26..00000000 --- a/docs/Vasv2taxMerchantInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Vasv2taxMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. | [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/Vasv2taxOrderInformation.md b/docs/Vasv2taxOrderInformation.md deleted file mode 100644 index 44f7c656..00000000 --- a/docs/Vasv2taxOrderInformation.md +++ /dev/null @@ -1,17 +0,0 @@ -# Vasv2taxOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount_details** | [**RiskV1DecisionsPost201ResponseOrderInformationAmountDetails**](RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md) | | [optional] -**bill_to** | [**Vasv2taxOrderInformationBillTo**](Vasv2taxOrderInformationBillTo.md) | | [optional] -**shipping_details** | [**Vasv2taxOrderInformationShippingDetails**](Vasv2taxOrderInformationShippingDetails.md) | | [optional] -**ship_to** | [**Vasv2taxOrderInformationShipTo**](Vasv2taxOrderInformationShipTo.md) | | [optional] -**line_items** | [**list[Vasv2taxOrderInformationLineItems]**](Vasv2taxOrderInformationLineItems.md) | | [optional] -**invoice_details** | [**Vasv2taxOrderInformationInvoiceDetails**](Vasv2taxOrderInformationInvoiceDetails.md) | | [optional] -**order_acceptance** | [**Vasv2taxOrderInformationOrderAcceptance**](Vasv2taxOrderInformationOrderAcceptance.md) | | [optional] -**order_origin** | [**Vasv2taxOrderInformationOrderOrigin**](Vasv2taxOrderInformationOrderOrigin.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/Vasv2taxOrderInformationBillTo.md b/docs/Vasv2taxOrderInformationBillTo.md deleted file mode 100644 index 83432cb4..00000000 --- a/docs/Vasv2taxOrderInformationBillTo.md +++ /dev/null @@ -1,15 +0,0 @@ -# Vasv2taxOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address1** | **str** | First line of the billing street address. #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**address2** | **str** | Second line of the billing street address. #### Tax Calculation Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**locality** | **str** | Credit card billing city. #### Tax Calculation Required for U.S. and Canadian taxes only. Not applicable to international and value added taxes. | [optional] -**administrative_area** | **str** | Credit card billing state or province. #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**postal_code** | **str** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. If the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example**: 12345-6789 If the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha] [numeric][alpha][numeric] **Example**: A1B 2C3 #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**country** | **str** | Credit card billing country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). If `orderInformation.shipTo.country` is not provided, `orderInformation.billTo.country` is used in its place. If `orderInformation.billTo.country` is set to `US` or `CA`, then `orderInformation.billTo.postalCode` and `orderInformation.billTo.administrativeArea` are also required. #### Tax Calculation Required for U.S., Canadian, international and value added 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/Vasv2taxOrderInformationInvoiceDetails.md b/docs/Vasv2taxOrderInformationInvoiceDetails.md deleted file mode 100644 index afdc6338..00000000 --- a/docs/Vasv2taxOrderInformationInvoiceDetails.md +++ /dev/null @@ -1,10 +0,0 @@ -# Vasv2taxOrderInformationInvoiceDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**invoice_date** | **str** | Date of the tax calculation. Use format YYYYMMDD. You can provide a date in the past if you are calculating tax for a refund and want to know what the tax was on the date the order was placed. You can provide a date in the future if you are calculating the tax for a future date, such as an upcoming tax holiday. The default is the date, in Pacific time, that the bank receives the request. Keep this in mind if you are in a different time zone and want the tax calculated with the rates that are applicable on a specific date. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added 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/Vasv2taxOrderInformationLineItems.md b/docs/Vasv2taxOrderInformationLineItems.md deleted file mode 100644 index 3dae99de..00000000 --- a/docs/Vasv2taxOrderInformationLineItems.md +++ /dev/null @@ -1,23 +0,0 @@ -# Vasv2taxOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] -**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] -**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] -**order_acceptance** | [**Vasv2taxOrderInformationOrderAcceptance**](Vasv2taxOrderInformationOrderAcceptance.md) | | [optional] -**order_origin** | [**Vasv2taxOrderInformationOrderOrigin**](Vasv2taxOrderInformationOrderOrigin.md) | | [optional] -**ship_from_country** | **str** | Country from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromAdministrativeArea` are present. Use the [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/ or rates applied to the transaction based on sourcing. Optional for U.S., Canadian, international tax, and value added taxes. | [optional] -**ship_from_administrative_area** | **str** | State from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromCountry` are present. Use the [State, Province, and Territory Codes for the United States and Canada](http://apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**ship_from_locality** | **str** | City where the product is shipped from. This field is used only when the `orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**ship_from_postal_code** | **str** | Postal code where the product is shipped from. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**buyer_vat_registration_number** | **str** | Buyer's VAT registration number. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] -**seller_vat_registration_number** | **str** | VAT seller registration number. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field 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/Vasv2taxOrderInformationOrderAcceptance.md b/docs/Vasv2taxOrderInformationOrderAcceptance.md deleted file mode 100644 index 9fe9b05c..00000000 --- a/docs/Vasv2taxOrderInformationOrderAcceptance.md +++ /dev/null @@ -1,13 +0,0 @@ -# Vasv2taxOrderInformationOrderAcceptance - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**locality** | **str** | Order acceptance city. This field is not used unless the `orderInformation.orderAcceptance.administrativeArea` and `orderInformation.orderAcceptance.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**administrative_area** | **str** | Order acceptance state. This field is not used unless the `orderInformation.orderAcceptance.locality` and `orderInformation.orderAcceptance.country` fields are present. 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). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**postal_code** | **str** | Order acceptance postal code. This field is not used unless the `orderInformation.orderAcceptance.locality`, `orderInformation.orderAcceptance.administrativeArea`, and `orderInformation.orderAcceptance.country` fields are present. Must be sent at the line or offer level to be surfaced in the Tax Detail Report. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**country** | **str** | Order acceptance country. This field is not used unless the `orderInformation.orderAcceptance.administrativeArea` and `orderInformation.orderAcceptance.locality` fields are present. Use the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added 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/Vasv2taxOrderInformationOrderOrigin.md b/docs/Vasv2taxOrderInformationOrderOrigin.md deleted file mode 100644 index 8eaba87f..00000000 --- a/docs/Vasv2taxOrderInformationOrderOrigin.md +++ /dev/null @@ -1,13 +0,0 @@ -# Vasv2taxOrderInformationOrderOrigin - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**locality** | **str** | Order origin city. This field is not used unless the `orderInformation.orderOrigin.administrativeArea` and `orderInformation.orderOrigin.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**administrative_area** | **str** | Order origin state. This field is not used unless the `orderInformation.orderOrigin.locality` and `orderInformation.orderOrigin.country` fields are present. Use the [State, Province, and Territory Codes for the United States and Canada](http://apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**postal_code** | **str** | Order origin postal code. This field is not used unless the `orderInformation.orderOrigin.locality`, `orderInformation.orderOrigin.administrativeArea` and `orderInformation.orderOrigin.country` fields are present. Must be sent at the lineItem level to appear in the Tax Detail Report. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**country** | **str** | Order origin country. This field is not used unless the `orderInformation.orderOrigin.administrativeArea` and `orderInformation.orderOrigin.locality` fields are present. Use the [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added 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/Vasv2taxOrderInformationShipTo.md b/docs/Vasv2taxOrderInformationShipTo.md deleted file mode 100644 index af13174f..00000000 --- a/docs/Vasv2taxOrderInformationShipTo.md +++ /dev/null @@ -1,16 +0,0 @@ -# Vasv2taxOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**address3** | **str** | Third line of the shipping address. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [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/Vasv2taxOrderInformationShippingDetails.md b/docs/Vasv2taxOrderInformationShippingDetails.md deleted file mode 100644 index 07eae06c..00000000 --- a/docs/Vasv2taxOrderInformationShippingDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# Vasv2taxOrderInformationShippingDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ship_from_locality** | **str** | City where the product is shipped from. This field is used only when the `orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**ship_from_country** | **str** | Country from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromAdministrativeArea` are present. Use the [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/ or rates applied to the transaction based on sourcing. Optional for U.S., Canadian, international tax, and value added taxes. | [optional] -**ship_from_postal_code** | **str** | Postal code where the product is shipped from. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] -**ship_from_administrative_area** | **str** | State from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromCountry` are present. Use the [State, Province, and Territory Codes for the United States and Canada](http://apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added 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/Vasv2taxTaxInformation.md b/docs/Vasv2taxTaxInformation.md deleted file mode 100644 index 64855d1a..00000000 --- a/docs/Vasv2taxTaxInformation.md +++ /dev/null @@ -1,16 +0,0 @@ -# Vasv2taxTaxInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reporting_date** | **str** | Reporting date of transaction. Format: YYYYMMDD. Defaults to current date if not specified. Optional for U.S., Canadian, international tax, and value added taxes. | [optional] -**date_override_reason** | **str** | If a past or future date is specified in `orderInformation.invoiceDetails.invoiceDate`, then provide the reason for that for audit purposes. Typical reasons include: 'Return', 'Layaway', 'Imported'. Optional for U.S., Canadian, international tax, and value added taxes. | [optional] -**nexus** | **list[str]** | Comma-separated list of states or provinces in which merchandise is taxable. Note merchandise may be still be non-taxable or tax exempt depending on the product taxability. Indicate the type of product you are selling in the product code field for product-level taxability rules to be applied. Do not use both the `taxInformation.nexus` and `taxInformation.noNexus` fields in your request. If you do not include this field in a tax calculation service request, the tax system makes its calculations as if you have nexus in every US state or Canadian province. 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). If you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report. Optional field for U.S. and Canadian taxes only. Either this field or `taxInformation.noNexus` is required if you do not have nexus in every state or province. Not applicable for international and value added taxes. | [optional] -**no_nexus** | **list[str]** | Comma-separated list of states or provinces where you do not have nexus. Check with a tax advisor to determine where your business has nexus. Do not use both the `taxInformation.nexus` and `taxInformation.noNexus` fields in your request. If you do not include this field in a tax calculation service request, the tax system makes its calculations as if you have nexus in every US state or Canadian province. 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). If you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report. Optional field for U.S. and Canadian taxes only. Either this field or `taxInformation.nexus` is required if you do not have nexus in every state or province. Not applicable for international and value added taxes. | [optional] -**show_tax_per_line_item** | **str** | Whether or not to display tax amounts for each line item. This field can contain one of the following values: - `Yes` - Display tax amounts for each line item - `No` (default) - Do not display tax amounts for each line item Optional for U.S., Canadian, international tax, and value added taxes. | [optional] -**commit_indicator** | **bool** | Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is \"Committed.\" For an uncommitted tax transaction, the status in the Tax Detail Report is \"Uncommitted.\" Possible values: - `true`: This is a committed tax transaction. - `false` (default): This is not a committed tax transaction. A committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed. The committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit. Use a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). | [optional] -**refund_indicator** | **bool** | Indicates whether this is a refund tax transaction. For a refund tax transaction, amounts in the Tax Detail Report will be negative. Possible values: - `true`: This is a refund tax transaction. - `false` (default): This is not a refund tax transaction. A refund tax request is a tax service request that sets the transaction type field in the Tax Detail Report to refunded and makes the reported amount negative. Tax amounts are returned as positive amounts in reply messages, but they are saved in reports as negative amounts which enables the reporting software to accurately calculate the aggregate amounts. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). | [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/Vasv2taxidClientReferenceInformation.md b/docs/Vasv2taxidClientReferenceInformation.md deleted file mode 100644 index 694d1365..00000000 --- a/docs/Vasv2taxidClientReferenceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Vasv2taxidClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | 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** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**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/docs/Vasv2taxidClientReferenceInformationPartner.md b/docs/Vasv2taxidClientReferenceInformationPartner.md deleted file mode 100644 index 2cdc9cc8..00000000 --- a/docs/Vasv2taxidClientReferenceInformationPartner.md +++ /dev/null @@ -1,11 +0,0 @@ -# Vasv2taxidClientReferenceInformationPartner - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**solution_id** | **str** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [optional] -**developer_id** | **str** | Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. | [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/VerificationApi.md b/docs/VerificationApi.md deleted file mode 100644 index 64bbbbd9..00000000 --- a/docs/VerificationApi.md +++ /dev/null @@ -1,106 +0,0 @@ -# CyberSource.VerificationApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**validate_export_compliance**](VerificationApi.md#validate_export_compliance) | **POST** /risk/v1/export-compliance-inquiries | Validate export compliance -[**verify_customer_address**](VerificationApi.md#verify_customer_address) | **POST** /risk/v1/address-verifications | Verify customer address - - -# **validate_export_compliance** -> RiskV1ExportComplianceInquiriesPost201Response validate_export_compliance(validate_export_compliance_request) - -Validate export compliance - -This call checks customer data against specified watch lists to ensure export compliance. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.VerificationApi() -validate_export_compliance_request = CyberSource.ValidateExportComplianceRequest() # ValidateExportComplianceRequest | - -try: - # Validate export compliance - api_response = api_instance.validate_export_compliance(validate_export_compliance_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling VerificationApi->validate_export_compliance: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **validate_export_compliance_request** | [**ValidateExportComplianceRequest**](ValidateExportComplianceRequest.md)| | - -### Return type - -[**RiskV1ExportComplianceInquiriesPost201Response**](RiskV1ExportComplianceInquiriesPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **verify_customer_address** -> RiskV1AddressVerificationsPost201Response verify_customer_address(verify_customer_address_request) - -Verify customer address - -This call verifies that the customer address submitted is valid. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.VerificationApi() -verify_customer_address_request = CyberSource.VerifyCustomerAddressRequest() # VerifyCustomerAddressRequest | - -try: - # Verify customer address - api_response = api_instance.verify_customer_address(verify_customer_address_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling VerificationApi->verify_customer_address: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **verify_customer_address_request** | [**VerifyCustomerAddressRequest**](VerifyCustomerAddressRequest.md)| | - -### Return type - -[**RiskV1AddressVerificationsPost201Response**](RiskV1AddressVerificationsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/VerifyCustomerAddressRequest.md b/docs/VerifyCustomerAddressRequest.md deleted file mode 100644 index 1e02669e..00000000 --- a/docs/VerifyCustomerAddressRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# VerifyCustomerAddressRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Riskv1liststypeentriesClientReferenceInformation**](Riskv1liststypeentriesClientReferenceInformation.md) | | [optional] -**order_information** | [**Riskv1addressverificationsOrderInformation**](Riskv1addressverificationsOrderInformation.md) | | [optional] -**buyer_information** | [**Riskv1addressverificationsBuyerInformation**](Riskv1addressverificationsBuyerInformation.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/VoidApi.md b/docs/VoidApi.md deleted file mode 100644 index 4be78186..00000000 --- a/docs/VoidApi.md +++ /dev/null @@ -1,261 +0,0 @@ -# CyberSource.VoidApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**mit_void**](VoidApi.md#mit_void) | **POST** /pts/v2/voids | Timeout Void -[**void_capture**](VoidApi.md#void_capture) | **POST** /pts/v2/captures/{id}/voids | Void a Capture -[**void_credit**](VoidApi.md#void_credit) | **POST** /pts/v2/credits/{id}/voids | Void a Credit -[**void_payment**](VoidApi.md#void_payment) | **POST** /pts/v2/payments/{id}/voids | Void a Payment -[**void_refund**](VoidApi.md#void_refund) | **POST** /pts/v2/refunds/{id}/voids | Void a Refund - - -# **mit_void** -> PtsV2PaymentsVoidsPost201Response mit_void(mit_void_request) - -Timeout Void - -This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in your payment, capture, refund, or credit API call and use same transactionId in this API request payload to reverse the payment. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.VoidApi() -mit_void_request = CyberSource.MitVoidRequest() # MitVoidRequest | - -try: - # Timeout Void - api_response = api_instance.mit_void(mit_void_request) - pprint(api_response) -except ApiException as e: - print("Exception when calling VoidApi->mit_void: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **mit_void_request** | [**MitVoidRequest**](MitVoidRequest.md)| | - -### Return type - -[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **void_capture** -> PtsV2PaymentsVoidsPost201Response void_capture(void_capture_request, id) - -Void a Capture - -Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. Include the capture ID in the POST request to cancel the capture. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.VoidApi() -void_capture_request = CyberSource.VoidCaptureRequest() # VoidCaptureRequest | -id = 'id_example' # str | The capture ID returned from a previous capture request. - -try: - # Void a Capture - api_response = api_instance.void_capture(void_capture_request, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling VoidApi->void_capture: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **void_capture_request** | [**VoidCaptureRequest**](VoidCaptureRequest.md)| | - **id** | **str**| The capture ID returned from a previous capture request. | - -### Return type - -[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **void_credit** -> PtsV2PaymentsVoidsPost201Response void_credit(void_credit_request, id) - -Void a Credit - -Include the credit ID in the POST request to cancel the credit. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.VoidApi() -void_credit_request = CyberSource.VoidCreditRequest() # VoidCreditRequest | -id = 'id_example' # str | The credit ID returned from a previous credit request. - -try: - # Void a Credit - api_response = api_instance.void_credit(void_credit_request, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling VoidApi->void_credit: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **void_credit_request** | [**VoidCreditRequest**](VoidCreditRequest.md)| | - **id** | **str**| The credit ID returned from a previous credit request. | - -### Return type - -[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **void_payment** -> PtsV2PaymentsVoidsPost201Response void_payment(void_payment_request, id) - -Void a Payment - -Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to cancel the payment. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.VoidApi() -void_payment_request = CyberSource.VoidPaymentRequest() # VoidPaymentRequest | -id = 'id_example' # str | The payment ID returned from a previous payment request. - -try: - # Void a Payment - api_response = api_instance.void_payment(void_payment_request, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling VoidApi->void_payment: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **void_payment_request** | [**VoidPaymentRequest**](VoidPaymentRequest.md)| | - **id** | **str**| The payment ID returned from a previous payment request. | - -### Return type - -[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **void_refund** -> PtsV2PaymentsVoidsPost201Response void_refund(void_refund_request, id) - -Void a Refund - -Include the refund ID in the POST request to cancel the refund. - -### Example -```python -from __future__ import print_function -import time -import CyberSource -from CyberSource.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = CyberSource.VoidApi() -void_refund_request = CyberSource.VoidRefundRequest() # VoidRefundRequest | -id = 'id_example' # str | The refund ID returned from a previous refund request. - -try: - # Void a Refund - api_response = api_instance.void_refund(void_refund_request, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling VoidApi->void_refund: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **void_refund_request** | [**VoidRefundRequest**](VoidRefundRequest.md)| | - **id** | **str**| The refund ID returned from a previous refund request. | - -### Return type - -[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json;charset=utf-8 - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/VoidCaptureRequest.md b/docs/VoidCaptureRequest.md deleted file mode 100644 index 26e97f74..00000000 --- a/docs/VoidCaptureRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# VoidCaptureRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional] -**payment_information** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional] -**order_information** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional] -**agreement_information** | [**Ptsv2paymentsidvoidsAgreementInformation**](Ptsv2paymentsidvoidsAgreementInformation.md) | | [optional] -**merchant_information** | [**Ptsv2paymentsidvoidsMerchantInformation**](Ptsv2paymentsidvoidsMerchantInformation.md) | | [optional] -**processing_information** | [**Ptsv2paymentsidvoidsProcessingInformation**](Ptsv2paymentsidvoidsProcessingInformation.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/VoidCreditRequest.md b/docs/VoidCreditRequest.md deleted file mode 100644 index dce2ba48..00000000 --- a/docs/VoidCreditRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# VoidCreditRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional] -**payment_information** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional] -**order_information** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional] -**agreement_information** | [**Ptsv2paymentsidvoidsAgreementInformation**](Ptsv2paymentsidvoidsAgreementInformation.md) | | [optional] -**merchant_information** | [**Ptsv2paymentsidvoidsMerchantInformation**](Ptsv2paymentsidvoidsMerchantInformation.md) | | [optional] -**processing_information** | [**Ptsv2paymentsidvoidsProcessingInformation**](Ptsv2paymentsidvoidsProcessingInformation.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/VoidPaymentRequest.md b/docs/VoidPaymentRequest.md deleted file mode 100644 index ef3867db..00000000 --- a/docs/VoidPaymentRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# VoidPaymentRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional] -**payment_information** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional] -**order_information** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional] -**agreement_information** | [**Ptsv2paymentsidvoidsAgreementInformation**](Ptsv2paymentsidvoidsAgreementInformation.md) | | [optional] -**merchant_information** | [**Ptsv2paymentsidvoidsMerchantInformation**](Ptsv2paymentsidvoidsMerchantInformation.md) | | [optional] -**processing_information** | [**Ptsv2paymentsidvoidsProcessingInformation**](Ptsv2paymentsidvoidsProcessingInformation.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/VoidRefundRequest.md b/docs/VoidRefundRequest.md deleted file mode 100644 index 1c15f29f..00000000 --- a/docs/VoidRefundRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# VoidRefundRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional] -**payment_information** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional] -**order_information** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional] -**agreement_information** | [**Ptsv2paymentsidvoidsAgreementInformation**](Ptsv2paymentsidvoidsAgreementInformation.md) | | [optional] -**merchant_information** | [**Ptsv2paymentsidvoidsMerchantInformation**](Ptsv2paymentsidvoidsMerchantInformation.md) | | [optional] -**processing_information** | [**Ptsv2paymentsidvoidsProcessingInformation**](Ptsv2paymentsidvoidsProcessingInformation.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/VoidTaxRequest.md b/docs/VoidTaxRequest.md deleted file mode 100644 index 0de6a14a..00000000 --- a/docs/VoidTaxRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# VoidTaxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**client_reference_information** | [**Vasv2taxidClientReferenceInformation**](Vasv2taxidClientReferenceInformation.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) - - From 3e56aeb7a135bcfee30015068db0fdc4856e7190 Mon Sep 17 00:00:00 2001 From: mahmishr Date: Tue, 23 Sep 2025 15:22:46 +0530 Subject: [PATCH 12/12] auto gen code --- CyberSource/api/batches_api.py | 20 +- CyberSource/api/billing_agreements_api.py | 15 +- CyberSource/api/bin_lookup_api.py | 5 +- CyberSource/api/capture_api.py | 5 +- CyberSource/api/chargeback_details_api.py | 5 +- CyberSource/api/chargeback_summaries_api.py | 5 +- CyberSource/api/conversion_details_api.py | 5 +- CyberSource/api/create_new_webhooks_api.py | 15 +- CyberSource/api/credit_api.py | 5 +- CyberSource/api/customer_api.py | 20 +- .../api/customer_payment_instrument_api.py | 25 +- .../api/customer_shipping_address_api.py | 25 +- CyberSource/api/decision_manager_api.py | 25 +- CyberSource/api/device_de_association_api.py | 10 +- CyberSource/api/device_search_api.py | 10 +- CyberSource/api/download_dtd_api.py | 5 +- CyberSource/api/download_xsd_api.py | 5 +- CyberSource/api/emv_tag_details_api.py | 10 +- CyberSource/api/flex_api_api.py | 5 +- CyberSource/api/instrument_identifier_api.py | 30 +- .../interchange_clearing_level_details_api.py | 5 +- CyberSource/api/invoice_settings_api.py | 10 +- CyberSource/api/invoices_api.py | 35 +- CyberSource/api/manage_webhooks_api.py | 35 +- CyberSource/api/merchant_boarding_api.py | 10 +- CyberSource/api/microform_integration_api.py | 5 +- CyberSource/api/net_fundings_api.py | 5 +- .../api/notification_of_changes_api.py | 5 +- CyberSource/api/orders_api.py | 10 +- CyberSource/api/payer_authentication_api.py | 15 +- .../api/payment_batch_summaries_api.py | 5 +- CyberSource/api/payment_instrument_api.py | 20 +- CyberSource/api/payment_links_api.py | 20 +- CyberSource/api/payment_tokens_api.py | 5 +- CyberSource/api/payments_api.py | 27 +- CyberSource/api/payouts_api.py | 5 +- CyberSource/api/plans_api.py | 40 +- .../api/purchase_and_refund_details_api.py | 5 +- CyberSource/api/push_funds_api.py | 5 +- CyberSource/api/refund_api.py | 10 +- CyberSource/api/report_definitions_api.py | 10 +- CyberSource/api/report_downloads_api.py | 5 +- CyberSource/api/report_subscriptions_api.py | 25 +- CyberSource/api/reports_api.py | 15 +- CyberSource/api/retrieval_details_api.py | 5 +- CyberSource/api/retrieval_summaries_api.py | 5 +- CyberSource/api/reversal_api.py | 10 +- CyberSource/api/search_transactions_api.py | 10 +- CyberSource/api/secure_file_share_api.py | 10 +- CyberSource/api/subscriptions_api.py | 40 +- .../api/subscriptions_follow_ons_api.py | 10 +- CyberSource/api/taxes_api.py | 10 +- CyberSource/api/token_api.py | 10 +- CyberSource/api/tokenized_card_api.py | 15 +- CyberSource/api/transaction_batches_api.py | 20 +- CyberSource/api/transaction_details_api.py | 5 +- CyberSource/api/transient_token_data_api.py | 10 +- .../unified_checkout_capture_context_api.py | 5 +- CyberSource/api/user_management_api.py | 5 +- CyberSource/api/user_management_search_api.py | 5 +- CyberSource/api/verification_api.py | 10 +- CyberSource/api/void_api.py | 25 +- CyberSource/api_client.py | 32 +- docs/PushFunds401Response.md | 13 + docs/PushFunds404Response.md | 13 + docs/PushFunds502Response.md | 14 + docs/PushFundsApi.md | 69 +++ docs/PushFundsRequest.md | 17 + docs/Rbsv1plansClientReferenceInformation.md | 14 + docs/Rbsv1plansOrderInformation.md | 10 + ...Rbsv1plansOrderInformationAmountDetails.md | 12 + docs/Rbsv1plansPlanInformation.md | 15 + .../Rbsv1plansPlanInformationBillingCycles.md | 10 + docs/Rbsv1plansidPlanInformation.md | 15 + docs/Rbsv1plansidProcessingInformation.md | 10 + ...ngInformationSubscriptionBillingOptions.md | 10 + ...subscriptionsClientReferenceInformation.md | 15 + ...ptionsClientReferenceInformationPartner.md | 11 + docs/Rbsv1subscriptionsPaymentInformation.md | 10 + ...subscriptionsPaymentInformationCustomer.md | 10 + docs/Rbsv1subscriptionsPlanInformation.md | 11 + ...Rbsv1subscriptionsProcessingInformation.md | 11 + ...ocessingInformationAuthorizationOptions.md | 10 + ...nformationAuthorizationOptionsInitiator.md | 10 + ...sv1subscriptionsSubscriptionInformation.md | 15 + docs/Rbsv1subscriptionsidOrderInformation.md | 10 + ...riptionsidOrderInformationAmountDetails.md | 11 + docs/Rbsv1subscriptionsidPlanInformation.md | 10 + ...1subscriptionsidSubscriptionInformation.md | 13 + docs/RefreshPaymentStatusRequest.md | 13 + docs/RefundApi.md | 110 +++++ docs/RefundCaptureRequest.md | 21 + docs/RefundPaymentRequest.md | 21 + docs/ReportDefinitionsApi.md | 114 +++++ docs/ReportDownloadsApi.md | 60 +++ docs/ReportSubscriptionsApi.md | 258 +++++++++++ ...ortingV3ChargebackDetailsGet200Response.md | 13 + ...kDetailsGet200ResponseChargebackDetails.md | 32 ++ ...tingV3ChargebackSummariesGet200Response.md | 13 + ...mariesGet200ResponseChargebackSummaries.md | 12 + ...ortingV3ConversionDetailsGet200Response.md | 13 + ...nDetailsGet200ResponseConversionDetails.md | 19 + ...gV3ConversionDetailsGet200ResponseNotes.md | 12 + ...hangeClearingLevelDetailsGet200Response.md | 12 + ...ResponseInterchangeClearingLevelDetails.md | 60 +++ docs/ReportingV3NetFundingsGet200Response.md | 17 + ...ndingsGet200ResponseNetFundingSummaries.md | 17 + ...NetFundingsGet200ResponseTotalPurchases.md | 11 + ...ngV3NotificationofChangesGet200Response.md | 10 + ...ngesGet200ResponseNotificationOfChanges.md | 17 + ...ngV3PaymentBatchSummariesGet200Response.md | 12 + ...riesGet200ResponsePaymentBatchSummaries.md | 21 + ...ngV3PurchaseRefundDetailsGet200Response.md | 18 + ...fundDetailsGet200ResponseAuthorizations.md | 17 + ...tailsGet200ResponseFeeAndFundingDetails.md | 22 + ...rchaseRefundDetailsGet200ResponseOthers.md | 16 + ...fundDetailsGet200ResponseRequestDetails.md | 15 + ...DetailsGet200ResponseSettlementStatuses.md | 14 + ...eRefundDetailsGet200ResponseSettlements.md | 22 + ...ortingV3ReportDefinitionsGet200Response.md | 10 + ...initionsGet200ResponseReportDefinitions.md | 16 + ...ngV3ReportDefinitionsNameGet200Response.md | 17 + ...DefinitionsNameGet200ResponseAttributes.md | 16 + ...itionsNameGet200ResponseDefaultSettings.md | 17 + ...tingV3ReportSubscriptionsGet200Response.md | 10 + ...ubscriptionsGet200ResponseSubscriptions.md | 23 + docs/ReportingV3ReportsGet200Response.md | 10 + docs/ReportingV3ReportsGet200ResponseLink.md | 10 + ...ReportsGet200ResponseLinkReportDownload.md | 11 + ...eportsGet200ResponseReportSearchResults.md | 25 ++ docs/ReportingV3ReportsIdGet200Response.md | 23 + ...portingV3RetrievalDetailsGet200Response.md | 13 + ...alDetailsGet200ResponseRetrievalDetails.md | 31 ++ ...rtingV3RetrievalSummariesGet200Response.md | 13 + ...eportingv3ReportDownloadsGet400Response.md | 13 + ...gv3ReportDownloadsGet400ResponseDetails.md | 11 + docs/Reportingv3reportsReportFilters.md | 13 + docs/Reportingv3reportsReportPreferences.md | 11 + docs/ReportsApi.md | 174 ++++++++ docs/Request.md | 11 + docs/ResourceNotFoundError.md | 11 + docs/RetrievalDetailsApi.md | 61 +++ docs/RetrievalSummariesApi.md | 61 +++ docs/ReversalApi.md | 108 +++++ docs/RiskProducts.md | 12 + docs/RiskProductsDecisionManager.md | 11 + ...DecisionManagerConfigurationInformation.md | 11 + docs/RiskProductsFraudManagementEssentials.md | 11 + ...ementEssentialsConfigurationInformation.md | 10 + docs/RiskProductsPortfolioRiskControls.md | 11 + ...lioRiskControlsConfigurationInformation.md | 10 + ...sConfigurationInformationConfigurations.md | 10 + ...skV1AddressVerificationsPost201Response.md | 18 + ...1ResponseAddressVerificationInformation.md | 17 + ...seAddressVerificationInformationBarCode.md | 11 + ...sVerificationInformationStandardAddress.md | 20 + ...ationInformationStandardAddressAddress1.md | 11 + ...icationsPost201ResponseErrorInformation.md | 12 + ...kV1AuthenticationResultsPost201Response.md | 17 + ...sponseConsumerAuthenticationInformation.md | 40 ++ ...skV1AuthenticationSetupsPost201Response.md | 16 + ...sponseConsumerAuthenticationInformation.md | 12 + ...onSetupsPost201ResponseErrorInformation.md | 12 + docs/RiskV1AuthenticationsPost201Response.md | 18 + ...icationsPost201ResponseErrorInformation.md | 12 + docs/RiskV1AuthenticationsPost400Response.md | 14 + docs/RiskV1AuthenticationsPost400Response1.md | 14 + docs/RiskV1DecisionsPost201Response.md | 21 + ...st201ResponseClientReferenceInformation.md | 12 + ...sponseConsumerAuthenticationInformation.md | 55 +++ ...ecisionsPost201ResponseErrorInformation.md | 12 + ...ecisionsPost201ResponseOrderInformation.md | 10 + ...01ResponseOrderInformationAmountDetails.md | 10 + ...isionsPost201ResponsePaymentInformation.md | 14 + docs/RiskV1DecisionsPost400Response.md | 14 + docs/RiskV1DecisionsPost400Response1.md | 14 + ...xportComplianceInquiriesPost201Response.md | 18 + ...nquiriesPost201ResponseErrorInformation.md | 12 + docs/RiskV1UpdatePost201Response.md | 14 + ...kv1addressverificationsBuyerInformation.md | 10 + ...kv1addressverificationsOrderInformation.md | 12 + ...ressverificationsOrderInformationBillTo.md | 17 + ...sverificationsOrderInformationLineItems.md | 15 + ...ressverificationsOrderInformationShipTo.md | 17 + ...esultsConsumerAuthenticationInformation.md | 17 + ...1authenticationresultsDeviceInformation.md | 10 + ...v1authenticationresultsOrderInformation.md | 10 + ...ionresultsOrderInformationAmountDetails.md | 11 + ...authenticationresultsPaymentInformation.md | 13 + ...enticationresultsPaymentInformationCard.md | 13 + ...ationresultsPaymentInformationFluidData.md | 13 + ...nresultsPaymentInformationTokenizedCard.md | 14 + docs/Riskv1authenticationsBuyerInformation.md | 13 + .../Riskv1authenticationsDeviceInformation.md | 21 + docs/Riskv1authenticationsOrderInformation.md | 17 + ...nticationsOrderInformationAmountDetails.md | 11 + ...v1authenticationsOrderInformationBillTo.md | 20 + ...uthenticationsOrderInformationLineItems.md | 29 ++ ...Riskv1authenticationsPaymentInformation.md | 13 + ...thenticationsPaymentInformationCustomer.md | 11 + ...icationsPaymentInformationTokenizedCard.md | 16 + docs/Riskv1authenticationsRiskInformation.md | 10 + .../Riskv1authenticationsTravelInformation.md | 12 + ...icationsetupsClientReferenceInformation.md | 13 + ...1authenticationsetupsPaymentInformation.md | 13 + ...henticationsetupsPaymentInformationCard.md | 13 + ...icationsetupsPaymentInformationCustomer.md | 10 + ...cationsetupsPaymentInformationFluidData.md | 13 + ...onsetupsPaymentInformationTokenizedCard.md | 14 + ...thenticationsetupsProcessingInformation.md | 11 + ...kv1authenticationsetupsTokenInformation.md | 11 + docs/Riskv1decisionsAcquirerInformation.md | 13 + docs/Riskv1decisionsBuyerInformation.md | 14 + ...skv1decisionsClientReferenceInformation.md | 13 + ...isionsClientReferenceInformationPartner.md | 11 + ...isionsConsumerAuthenticationInformation.md | 49 +++ ...ticationInformationStrongAuthentication.md | 10 + docs/Riskv1decisionsDeviceInformation.md | 26 ++ ...skv1decisionsMerchantDefinedInformation.md | 11 + docs/Riskv1decisionsMerchantInformation.md | 11 + ...nsMerchantInformationMerchantDescriptor.md | 11 + docs/Riskv1decisionsOrderInformation.md | 20 + ...1decisionsOrderInformationAmountDetails.md | 11 + docs/Riskv1decisionsOrderInformationBillTo.md | 19 + ...iskv1decisionsOrderInformationLineItems.md | 25 ++ docs/Riskv1decisionsOrderInformationShipTo.md | 23 + ...ecisionsOrderInformationShippingDetails.md | 11 + docs/Riskv1decisionsPaymentInformation.md | 14 + docs/Riskv1decisionsPaymentInformationCard.md | 14 + ...ecisionsPaymentInformationTokenizedCard.md | 14 + docs/Riskv1decisionsProcessingInformation.md | 10 + docs/Riskv1decisionsProcessorInformation.md | 11 + .../Riskv1decisionsProcessorInformationAvs.md | 10 + ...onsProcessorInformationCardVerification.md | 10 + docs/Riskv1decisionsRiskInformation.md | 13 + docs/Riskv1decisionsTokenInformation.md | 10 + docs/Riskv1decisionsTravelInformation.md | 16 + docs/Riskv1decisionsTravelInformationLegs.md | 14 + ...kv1decisionsTravelInformationPassengers.md | 11 + ...v1decisionsidactionsDecisionInformation.md | 11 + ...decisionsidactionsProcessingInformation.md | 10 + ...Riskv1decisionsidmarkingRiskInformation.md | 10 + ...sidmarkingRiskInformationMarkingDetails.md | 13 + ...ortcomplianceinquiriesDeviceInformation.md | 11 + ...nceinquiriesExportComplianceInformation.md | 12 + ...portcomplianceinquiriesOrderInformation.md | 12 + ...mplianceinquiriesOrderInformationBillTo.md | 21 + ...einquiriesOrderInformationBillToCompany.md | 10 + ...ianceinquiriesOrderInformationLineItems.md | 17 + ...mplianceinquiriesOrderInformationShipTo.md | 12 + .../Riskv1liststypeentriesBuyerInformation.md | 10 + ...tstypeentriesClientReferenceInformation.md | 12 + ...Riskv1liststypeentriesDeviceInformation.md | 11 + .../Riskv1liststypeentriesOrderInformation.md | 13 + ...liststypeentriesOrderInformationAddress.md | 15 + ...1liststypeentriesOrderInformationBillTo.md | 20 + ...ststypeentriesOrderInformationLineItems.md | 10 + ...1liststypeentriesOrderInformationShipTo.md | 15 + ...iskv1liststypeentriesPaymentInformation.md | 11 + ...1liststypeentriesPaymentInformationBank.md | 13 + ...1liststypeentriesPaymentInformationCard.md | 12 + docs/Riskv1liststypeentriesRiskInformation.md | 10 + ...ypeentriesRiskInformationMarkingDetails.md | 13 + docs/SAConfig.md | 16 + docs/SAConfigCheckout.md | 12 + docs/SAConfigContactInformation.md | 13 + docs/SAConfigNotifications.md | 11 + ...onfigNotificationsCustomerNotifications.md | 16 + ...onfigNotificationsMerchantNotifications.md | 14 + docs/SAConfigPaymentMethods.md | 10 + docs/SAConfigPaymentTypes.md | 10 + docs/SAConfigPaymentTypesCardTypes.md | 13 + docs/SAConfigPaymentTypesCardTypesDiscover.md | 16 + docs/SAConfigService.md | 16 + docs/SaveAsymEgressKey.md | 12 + docs/SaveSymEgressKey.md | 12 + docs/SearchRequest.md | 13 + docs/SearchTransactionsApi.md | 106 +++++ docs/SecureFileShareApi.md | 113 +++++ docs/ShippingAddressListForCustomer.md | 15 + .../ShippingAddressListForCustomerEmbedded.md | 10 + docs/ShippingAddressListForCustomerLinks.md | 14 + ...hippingAddressListForCustomerLinksFirst.md | 10 + ...ShippingAddressListForCustomerLinksLast.md | 10 + ...ShippingAddressListForCustomerLinksNext.md | 10 + ...ShippingAddressListForCustomerLinksPrev.md | 10 + ...ShippingAddressListForCustomerLinksSelf.md | 10 + docs/SubscriptionsApi.md | 406 ++++++++++++++++++ docs/SubscriptionsFollowOnsApi.md | 108 +++++ docs/SuspendSubscriptionResponse.md | 14 + ...criptionResponseSubscriptionInformation.md | 11 + docs/TaxRequest.md | 14 + docs/TaxesApi.md | 108 +++++ docs/TmsAuthorizationOptions.md | 10 + docs/TmsAuthorizationOptionsInitiator.md | 10 + ...nsInitiatorMerchantInitiatedTransaction.md | 11 + docs/TmsBinLookup.md | 11 + docs/TmsBinLookupIssuerInformation.md | 14 + docs/TmsBinLookupPaymentAccountInformation.md | 12 + ...sBinLookupPaymentAccountInformationCard.md | 15 + ...okupPaymentAccountInformationCardBrands.md | 11 + ...LookupPaymentAccountInformationFeatures.md | 28 ++ ...nLookupPaymentAccountInformationNetwork.md | 10 + docs/TmsBusinessInformation.md | 16 + docs/TmsBusinessInformationAcquirer.md | 11 + docs/TmsBusinessInformationAddress.md | 11 + docs/TmsCardArt.md | 14 + docs/TmsCardArtBrandLogoAsset.md | 11 + docs/TmsCardArtBrandLogoAssetLinks.md | 10 + docs/TmsCardArtBrandLogoAssetLinksSelf.md | 10 + docs/TmsCardArtCombinedAsset.md | 11 + docs/TmsCardArtCombinedAssetLinks.md | 10 + docs/TmsCardArtCombinedAssetLinksSelf.md | 10 + docs/TmsCardArtIconAsset.md | 11 + docs/TmsCardArtIconAssetLinks.md | 10 + docs/TmsCardArtIconAssetLinksSelf.md | 10 + docs/TmsCardArtIssuerLogoAsset.md | 11 + docs/TmsCardArtIssuerLogoAssetLinks.md | 10 + docs/TmsCardArtIssuerLogoAssetLinksSelf.md | 10 + docs/TmsEmbeddedInstrumentIdentifier.md | 23 + ...EmbeddedInstrumentIdentifierBankAccount.md | 11 + docs/TmsEmbeddedInstrumentIdentifierBillTo.md | 15 + docs/TmsEmbeddedInstrumentIdentifierCard.md | 13 + ...TmsEmbeddedInstrumentIdentifierEmbedded.md | 10 + docs/TmsEmbeddedInstrumentIdentifierIssuer.md | 10 + docs/TmsEmbeddedInstrumentIdentifierLinks.md | 11 + ...rumentIdentifierLinksPaymentInstruments.md | 10 + ...msEmbeddedInstrumentIdentifierLinksSelf.md | 10 + ...TmsEmbeddedInstrumentIdentifierMetadata.md | 10 + ...strumentIdentifierProcessingInformation.md | 10 + docs/TmsNetworkTokenServices.md | 15 + ...okenServicesAmericanExpressTokenService.md | 13 + ...vicesMastercardDigitalEnablementService.md | 12 + docs/TmsNetworkTokenServicesNotifications.md | 10 + ...sNetworkTokenServicesPaymentCredentials.md | 10 + ...orkTokenServicesSynchronousProvisioning.md | 10 + ...TmsNetworkTokenServicesVisaTokenService.md | 13 + docs/TmsNullify.md | 12 + docs/TmsPaymentInstrumentProcessingInfo.md | 11 + ...rumentProcessingInfoBankTransferOptions.md | 10 + docs/TmsSensitivePrivileges.md | 10 + docs/TmsTokenFormats.md | 13 + docs/Tmsv2TokenizedCard.md | 32 ++ docs/Tmsv2TokenizedCardCard.md | 14 + docs/Tmsv2TokenizedCardLinks.md | 10 + docs/Tmsv2TokenizedCardLinksSelf.md | 10 + docs/Tmsv2TokenizedCardMetadata.md | 11 + docs/Tmsv2TokenizedCardMetadataIssuer.md | 12 + docs/Tmsv2TokenizedCardPasscode.md | 10 + docs/Tmsv2customersBuyerInformation.md | 11 + ...msv2customersClientReferenceInformation.md | 10 + .../Tmsv2customersDefaultPaymentInstrument.md | 10 + docs/Tmsv2customersDefaultShippingAddress.md | 10 + docs/Tmsv2customersEmbedded.md | 11 + ...stomersEmbeddedDefaultPaymentInstrument.md | 24 ++ ...ddedDefaultPaymentInstrumentBankAccount.md | 10 + ...sEmbeddedDefaultPaymentInstrumentBillTo.md | 20 + ...efaultPaymentInstrumentBuyerInformation.md | 13 + ...ymentInstrumentBuyerInformationIssuedBy.md | 10 + ...tBuyerInformationPersonalIdentification.md | 12 + ...ersEmbeddedDefaultPaymentInstrumentCard.md | 18 + ...ymentInstrumentCardTokenizedInformation.md | 11 + ...mbeddedDefaultPaymentInstrumentEmbedded.md | 10 + ...ltPaymentInstrumentInstrumentIdentifier.md | 10 + ...rsEmbeddedDefaultPaymentInstrumentLinks.md | 11 + ...beddedDefaultPaymentInstrumentLinksSelf.md | 10 + ...ultPaymentInstrumentMerchantInformation.md | 10 + ...ntMerchantInformationMerchantDescriptor.md | 10 + ...mbeddedDefaultPaymentInstrumentMetadata.md | 10 + ...customersEmbeddedDefaultShippingAddress.md | 14 + ...mersEmbeddedDefaultShippingAddressLinks.md | 11 + ...ddedDefaultShippingAddressLinksCustomer.md | 10 + ...EmbeddedDefaultShippingAddressLinksSelf.md | 10 + ...sEmbeddedDefaultShippingAddressMetadata.md | 10 + ...ersEmbeddedDefaultShippingAddressShipTo.md | 20 + docs/Tmsv2customersLinks.md | 12 + docs/Tmsv2customersLinksPaymentInstruments.md | 10 + docs/Tmsv2customersLinksSelf.md | 10 + docs/Tmsv2customersLinksShippingAddress.md | 10 + ...msv2customersMerchantDefinedInformation.md | 11 + docs/Tmsv2customersMetadata.md | 10 + docs/Tmsv2customersObjectInformation.md | 11 + docs/TokenApi.md | 114 +++++ docs/TokenPermissions.md | 13 + docs/TokenizedCardApi.md | 160 +++++++ docs/TokenizedcardRequest.md | 32 ++ docs/TransactionBatchesApi.md | 208 +++++++++ docs/TransactionDetailsApi.md | 57 +++ docs/TransientTokenDataApi.md | 105 +++++ docs/TssV2GetEmvTags200Response.md | 10 + ...etEmvTags200ResponseEmvTagBreakdownList.md | 11 + docs/TssV2PostEmvTags200Response.md | 10 + ...stEmvTags200ResponseEmvTagBreakdownList.md | 14 + ...PostEmvTags200ResponseParsedEMVTagsList.md | 12 + docs/TssV2TransactionsGet200Response.md | 40 ++ ...onsGet200ResponseApplicationInformation.md | 14 + ...ponseApplicationInformationApplications.md | 17 + ...ionsGet200ResponseBankAccountValidation.md | 12 + ...nsactionsGet200ResponseBuyerInformation.md | 11 + ...et200ResponseClientReferenceInformation.md | 15 + ...sponseClientReferenceInformationPartner.md | 11 + ...sponseConsumerAuthenticationInformation.md | 14 + ...ticationInformationStrongAuthentication.md | 14 + ...sactionsGet200ResponseDeviceInformation.md | 12 + ...nsactionsGet200ResponseErrorInformation.md | 12 + ...nsGet200ResponseFraudMarkingInformation.md | 10 + ...onsGet200ResponseInstallmentInformation.md | 11 + docs/TssV2TransactionsGet200ResponseLinks.md | 11 + ...ctionsGet200ResponseMerchantInformation.md | 10 + ...seMerchantInformationMerchantDescriptor.md | 10 + ...nsactionsGet200ResponseOrderInformation.md | 15 + ...00ResponseOrderInformationAmountDetails.md | 16 + ...onsGet200ResponseOrderInformationBillTo.md | 23 + ...0ResponseOrderInformationInvoiceDetails.md | 10 + ...Get200ResponseOrderInformationLineItems.md | 16 + ...onsGet200ResponseOrderInformationShipTo.md | 19 + ...ResponseOrderInformationShippingDetails.md | 11 + ...actionsGet200ResponsePaymentInformation.md | 23 + ...sponsePaymentInformationAccountFeatures.md | 12 + ...onsGet200ResponsePaymentInformationBank.md | 16 + ...00ResponsePaymentInformationBankAccount.md | 16 + ...00ResponsePaymentInformationBankMandate.md | 12 + ...sGet200ResponsePaymentInformationBrands.md | 11 + ...onsGet200ResponsePaymentInformationCard.md | 21 + ...et200ResponsePaymentInformationCustomer.md | 11 + ...et200ResponsePaymentInformationFeatures.md | 16 + ...t200ResponsePaymentInformationFluidData.md | 10 + ...ePaymentInformationInstrumentIdentifier.md | 10 + ...Get200ResponsePaymentInformationInvoice.md | 12 + ...onsePaymentInformationIssuerInformation.md | 14 + ...Get200ResponsePaymentInformationNetwork.md | 10 + ...00ResponsePaymentInformationPaymentType.md | 12 + ...TransactionsGet200ResponsePayoutOptions.md | 10 + ...onsGet200ResponsePointOfSaleInformation.md | 14 + ...ionsGet200ResponseProcessingInformation.md | 21 + ...ocessingInformationAuthorizationOptions.md | 14 + ...nformationAuthorizationOptionsInitiator.md | 13 + ...rocessingInformationBankTransferOptions.md | 10 + ...onseProcessingInformationCaptureOptions.md | 11 + ...rocessingInformationJapanPaymentOptions.md | 18 + ...tionsGet200ResponseProcessorInformation.md | 26 ++ ...nformationElectronicVerificationResults.md | 19 + ...ocessorInformationMultiProcessorRouting.md | 13 + ...00ResponseProcessorInformationProcessor.md | 10 + ...t200ResponseRecurringPaymentInformation.md | 10 + ...ansactionsGet200ResponseRiskInformation.md | 15 + ...onsGet200ResponseRiskInformationProfile.md | 11 + ...tionsGet200ResponseRiskInformationRules.md | 11 + ...tionsGet200ResponseRiskInformationScore.md | 11 + ...sactionsGet200ResponseSenderInformation.md | 10 + ...nsactionsGet200ResponseTokenInformation.md | 15 + docs/TssV2TransactionsPost201Response.md | 22 + ...ssV2TransactionsPost201ResponseEmbedded.md | 10 + ...1ResponseEmbeddedApplicationInformation.md | 14 + ...eddedApplicationInformationApplications.md | 18 + ...ponseEmbeddedClientReferenceInformation.md | 13 + ...beddedClientReferenceInformationPartner.md | 10 + ...beddedConsumerAuthenticationInformation.md | 12 + ...Post201ResponseEmbeddedErrorInformation.md | 10 + ...ransactionsPost201ResponseEmbeddedLinks.md | 10 + ...t201ResponseEmbeddedMerchantInformation.md | 10 + ...Post201ResponseEmbeddedOrderInformation.md | 12 + ...1ResponseEmbeddedOrderInformationBillTo.md | 15 + ...1ResponseEmbeddedOrderInformationShipTo.md | 14 + ...st201ResponseEmbeddedPaymentInformation.md | 13 + ...1ResponseEmbeddedPaymentInformationBank.md | 10 + ...seEmbeddedPaymentInformationBankAccount.md | 11 + ...1ResponseEmbeddedPaymentInformationCard.md | 12 + ...seEmbeddedPaymentInformationPaymentType.md | 11 + ...1ResponseEmbeddedPointOfSaleInformation.md | 14 + ...seEmbeddedPointOfSaleInformationPartner.md | 10 + ...01ResponseEmbeddedProcessingInformation.md | 13 + ...201ResponseEmbeddedProcessorInformation.md | 14 + ...sPost201ResponseEmbeddedRiskInformation.md | 10 + ...esponseEmbeddedRiskInformationProviders.md | 10 + ...ddedRiskInformationProvidersFingerprint.md | 12 + ...201ResponseEmbeddedTransactionSummaries.md | 29 ++ ...transactionsemvTagDetailsEmvDetailsList.md | 11 + docs/UmsV1UsersGet200Response.md | 10 + ...V1UsersGet200ResponseAccountInformation.md | 17 + ...V1UsersGet200ResponseContactInformation.md | 13 + ...rsGet200ResponseOrganizationInformation.md | 10 + docs/UmsV1UsersGet200ResponseUsers.md | 13 + docs/UnauthorizedClientError.md | 11 + docs/UnifiedCheckoutCaptureContextApi.md | 57 +++ docs/UpdateInvoiceRequest.md | 13 + docs/UpdateOrderRequest.md | 14 + docs/UpdatePaymentLinkRequest.md | 14 + docs/UpdatePlanRequest.md | 12 + docs/UpdatePlanResponse.md | 14 + docs/UpdatePlanResponsePlanInformation.md | 11 + docs/UpdateStatus.md | 10 + docs/UpdateSubscription.md | 14 + docs/UpdateSubscriptionResponse.md | 14 + docs/UpdateWebhook.md | 17 + docs/Upv1capturecontextsCaptureMandate.md | 19 + docs/Upv1capturecontextsCompleteMandate.md | 12 + docs/Upv1capturecontextsOrderInformation.md | 12 + ...recontextsOrderInformationAmountDetails.md | 11 + ...v1capturecontextsOrderInformationBillTo.md | 28 ++ ...recontextsOrderInformationBillToCompany.md | 20 + ...v1capturecontextsOrderInformationShipTo.md | 21 + docs/UserManagementApi.md | 63 +++ docs/UserManagementSearchApi.md | 57 +++ docs/V1FileDetailsGet200Response.md | 11 + .../V1FileDetailsGet200ResponseFileDetails.md | 16 + docs/V1FileDetailsGet200ResponseLinks.md | 11 + docs/V1FileDetailsGet200ResponseLinksFiles.md | 12 + docs/V1FileDetailsGet200ResponseLinksSelf.md | 11 + docs/VTConfig.md | 11 + docs/VTConfigCardNotPresent.md | 11 + ...gCardNotPresentGlobalPaymentInformation.md | 12 + ...lobalPaymentInformationBasicInformation.md | 18 + ...entInformationMerchantDefinedDataFields.md | 34 ++ ...balPaymentInformationPaymentInformation.md | 22 + ...TConfigCardNotPresentReceiptInformation.md | 12 + ...otPresentReceiptInformationEmailReceipt.md | 10 + ...gCardNotPresentReceiptInformationHeader.md | 10 + ...esentReceiptInformationOrderInformation.md | 11 + docs/ValidateExportComplianceRequest.md | 14 + docs/ValidateRequest.md | 16 + docs/ValueAddedServicesProducts.md | 12 + docs/VasV2PaymentsPost201Response.md | 16 + docs/VasV2PaymentsPost201ResponseLinks.md | 10 + ...PaymentsPost201ResponseOrderInformation.md | 15 + ...201ResponseOrderInformationJurisdiction.md | 18 + ...ost201ResponseOrderInformationLineItems.md | 14 + ...st201ResponseOrderInformationTaxDetails.md | 11 + ...V2PaymentsPost201ResponseTaxInformation.md | 11 + docs/VasV2PaymentsPost400Response.md | 14 + docs/VasV2TaxVoid200Response.md | 14 + ...asV2TaxVoid200ResponseVoidAmountDetails.md | 11 + docs/VasV2TaxVoidsPost400Response.md | 14 + docs/Vasv2taxBuyerInformation.md | 10 + docs/Vasv2taxClientReferenceInformation.md | 12 + docs/Vasv2taxMerchantInformation.md | 10 + docs/Vasv2taxOrderInformation.md | 17 + docs/Vasv2taxOrderInformationBillTo.md | 15 + .../Vasv2taxOrderInformationInvoiceDetails.md | 10 + docs/Vasv2taxOrderInformationLineItems.md | 23 + ...Vasv2taxOrderInformationOrderAcceptance.md | 13 + docs/Vasv2taxOrderInformationOrderOrigin.md | 13 + docs/Vasv2taxOrderInformationShipTo.md | 16 + ...Vasv2taxOrderInformationShippingDetails.md | 13 + docs/Vasv2taxTaxInformation.md | 16 + docs/Vasv2taxidClientReferenceInformation.md | 12 + ...2taxidClientReferenceInformationPartner.md | 11 + docs/VerificationApi.md | 106 +++++ docs/VerifyCustomerAddressRequest.md | 12 + docs/VoidApi.md | 261 +++++++++++ docs/VoidCaptureRequest.md | 15 + docs/VoidCreditRequest.md | 15 + docs/VoidPaymentRequest.md | 15 + docs/VoidRefundRequest.md | 15 + docs/VoidTaxRequest.md | 10 + 555 files changed, 10126 insertions(+), 175 deletions(-) create mode 100644 docs/PushFunds401Response.md create mode 100644 docs/PushFunds404Response.md create mode 100644 docs/PushFunds502Response.md create mode 100644 docs/PushFundsApi.md create mode 100644 docs/PushFundsRequest.md create mode 100644 docs/Rbsv1plansClientReferenceInformation.md create mode 100644 docs/Rbsv1plansOrderInformation.md create mode 100644 docs/Rbsv1plansOrderInformationAmountDetails.md create mode 100644 docs/Rbsv1plansPlanInformation.md create mode 100644 docs/Rbsv1plansPlanInformationBillingCycles.md create mode 100644 docs/Rbsv1plansidPlanInformation.md create mode 100644 docs/Rbsv1plansidProcessingInformation.md create mode 100644 docs/Rbsv1plansidProcessingInformationSubscriptionBillingOptions.md create mode 100644 docs/Rbsv1subscriptionsClientReferenceInformation.md create mode 100644 docs/Rbsv1subscriptionsClientReferenceInformationPartner.md create mode 100644 docs/Rbsv1subscriptionsPaymentInformation.md create mode 100644 docs/Rbsv1subscriptionsPaymentInformationCustomer.md create mode 100644 docs/Rbsv1subscriptionsPlanInformation.md create mode 100644 docs/Rbsv1subscriptionsProcessingInformation.md create mode 100644 docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptions.md create mode 100644 docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.md create mode 100644 docs/Rbsv1subscriptionsSubscriptionInformation.md create mode 100644 docs/Rbsv1subscriptionsidOrderInformation.md create mode 100644 docs/Rbsv1subscriptionsidOrderInformationAmountDetails.md create mode 100644 docs/Rbsv1subscriptionsidPlanInformation.md create mode 100644 docs/Rbsv1subscriptionsidSubscriptionInformation.md create mode 100644 docs/RefreshPaymentStatusRequest.md create mode 100644 docs/RefundApi.md create mode 100644 docs/RefundCaptureRequest.md create mode 100644 docs/RefundPaymentRequest.md create mode 100644 docs/ReportDefinitionsApi.md create mode 100644 docs/ReportDownloadsApi.md create mode 100644 docs/ReportSubscriptionsApi.md create mode 100644 docs/ReportingV3ChargebackDetailsGet200Response.md create mode 100644 docs/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md create mode 100644 docs/ReportingV3ChargebackSummariesGet200Response.md create mode 100644 docs/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md create mode 100644 docs/ReportingV3ConversionDetailsGet200Response.md create mode 100644 docs/ReportingV3ConversionDetailsGet200ResponseConversionDetails.md create mode 100644 docs/ReportingV3ConversionDetailsGet200ResponseNotes.md create mode 100644 docs/ReportingV3InterchangeClearingLevelDetailsGet200Response.md create mode 100644 docs/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md create mode 100644 docs/ReportingV3NetFundingsGet200Response.md create mode 100644 docs/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md create mode 100644 docs/ReportingV3NetFundingsGet200ResponseTotalPurchases.md create mode 100644 docs/ReportingV3NotificationofChangesGet200Response.md create mode 100644 docs/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md create mode 100644 docs/ReportingV3PaymentBatchSummariesGet200Response.md create mode 100644 docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md create mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200Response.md create mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md create mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md create mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md create mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md create mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md create mode 100644 docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md create mode 100644 docs/ReportingV3ReportDefinitionsGet200Response.md create mode 100644 docs/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.md create mode 100644 docs/ReportingV3ReportDefinitionsNameGet200Response.md create mode 100644 docs/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md create mode 100644 docs/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md create mode 100644 docs/ReportingV3ReportSubscriptionsGet200Response.md create mode 100644 docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md create mode 100644 docs/ReportingV3ReportsGet200Response.md create mode 100644 docs/ReportingV3ReportsGet200ResponseLink.md create mode 100644 docs/ReportingV3ReportsGet200ResponseLinkReportDownload.md create mode 100644 docs/ReportingV3ReportsGet200ResponseReportSearchResults.md create mode 100644 docs/ReportingV3ReportsIdGet200Response.md create mode 100644 docs/ReportingV3RetrievalDetailsGet200Response.md create mode 100644 docs/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md create mode 100644 docs/ReportingV3RetrievalSummariesGet200Response.md create mode 100644 docs/Reportingv3ReportDownloadsGet400Response.md create mode 100644 docs/Reportingv3ReportDownloadsGet400ResponseDetails.md create mode 100644 docs/Reportingv3reportsReportFilters.md create mode 100644 docs/Reportingv3reportsReportPreferences.md create mode 100644 docs/ReportsApi.md create mode 100644 docs/Request.md create mode 100644 docs/ResourceNotFoundError.md create mode 100644 docs/RetrievalDetailsApi.md create mode 100644 docs/RetrievalSummariesApi.md create mode 100644 docs/ReversalApi.md create mode 100644 docs/RiskProducts.md create mode 100644 docs/RiskProductsDecisionManager.md create mode 100644 docs/RiskProductsDecisionManagerConfigurationInformation.md create mode 100644 docs/RiskProductsFraudManagementEssentials.md create mode 100644 docs/RiskProductsFraudManagementEssentialsConfigurationInformation.md create mode 100644 docs/RiskProductsPortfolioRiskControls.md create mode 100644 docs/RiskProductsPortfolioRiskControlsConfigurationInformation.md create mode 100644 docs/RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.md create mode 100644 docs/RiskV1AddressVerificationsPost201Response.md create mode 100644 docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md create mode 100644 docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md create mode 100644 docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.md create mode 100644 docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md create mode 100644 docs/RiskV1AddressVerificationsPost201ResponseErrorInformation.md create mode 100644 docs/RiskV1AuthenticationResultsPost201Response.md create mode 100644 docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md create mode 100644 docs/RiskV1AuthenticationSetupsPost201Response.md create mode 100644 docs/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md create mode 100644 docs/RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md create mode 100644 docs/RiskV1AuthenticationsPost201Response.md create mode 100644 docs/RiskV1AuthenticationsPost201ResponseErrorInformation.md create mode 100644 docs/RiskV1AuthenticationsPost400Response.md create mode 100644 docs/RiskV1AuthenticationsPost400Response1.md create mode 100644 docs/RiskV1DecisionsPost201Response.md create mode 100644 docs/RiskV1DecisionsPost201ResponseClientReferenceInformation.md create mode 100644 docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md create mode 100644 docs/RiskV1DecisionsPost201ResponseErrorInformation.md create mode 100644 docs/RiskV1DecisionsPost201ResponseOrderInformation.md create mode 100644 docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md create mode 100644 docs/RiskV1DecisionsPost201ResponsePaymentInformation.md create mode 100644 docs/RiskV1DecisionsPost400Response.md create mode 100644 docs/RiskV1DecisionsPost400Response1.md create mode 100644 docs/RiskV1ExportComplianceInquiriesPost201Response.md create mode 100644 docs/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.md create mode 100644 docs/RiskV1UpdatePost201Response.md create mode 100644 docs/Riskv1addressverificationsBuyerInformation.md create mode 100644 docs/Riskv1addressverificationsOrderInformation.md create mode 100644 docs/Riskv1addressverificationsOrderInformationBillTo.md create mode 100644 docs/Riskv1addressverificationsOrderInformationLineItems.md create mode 100644 docs/Riskv1addressverificationsOrderInformationShipTo.md create mode 100644 docs/Riskv1authenticationresultsConsumerAuthenticationInformation.md create mode 100644 docs/Riskv1authenticationresultsDeviceInformation.md create mode 100644 docs/Riskv1authenticationresultsOrderInformation.md create mode 100644 docs/Riskv1authenticationresultsOrderInformationAmountDetails.md create mode 100644 docs/Riskv1authenticationresultsPaymentInformation.md create mode 100644 docs/Riskv1authenticationresultsPaymentInformationCard.md create mode 100644 docs/Riskv1authenticationresultsPaymentInformationFluidData.md create mode 100644 docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md create mode 100644 docs/Riskv1authenticationsBuyerInformation.md create mode 100644 docs/Riskv1authenticationsDeviceInformation.md create mode 100644 docs/Riskv1authenticationsOrderInformation.md create mode 100644 docs/Riskv1authenticationsOrderInformationAmountDetails.md create mode 100644 docs/Riskv1authenticationsOrderInformationBillTo.md create mode 100644 docs/Riskv1authenticationsOrderInformationLineItems.md create mode 100644 docs/Riskv1authenticationsPaymentInformation.md create mode 100644 docs/Riskv1authenticationsPaymentInformationCustomer.md create mode 100644 docs/Riskv1authenticationsPaymentInformationTokenizedCard.md create mode 100644 docs/Riskv1authenticationsRiskInformation.md create mode 100644 docs/Riskv1authenticationsTravelInformation.md create mode 100644 docs/Riskv1authenticationsetupsClientReferenceInformation.md create mode 100644 docs/Riskv1authenticationsetupsPaymentInformation.md create mode 100644 docs/Riskv1authenticationsetupsPaymentInformationCard.md create mode 100644 docs/Riskv1authenticationsetupsPaymentInformationCustomer.md create mode 100644 docs/Riskv1authenticationsetupsPaymentInformationFluidData.md create mode 100644 docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md create mode 100644 docs/Riskv1authenticationsetupsProcessingInformation.md create mode 100644 docs/Riskv1authenticationsetupsTokenInformation.md create mode 100644 docs/Riskv1decisionsAcquirerInformation.md create mode 100644 docs/Riskv1decisionsBuyerInformation.md create mode 100644 docs/Riskv1decisionsClientReferenceInformation.md create mode 100644 docs/Riskv1decisionsClientReferenceInformationPartner.md create mode 100644 docs/Riskv1decisionsConsumerAuthenticationInformation.md create mode 100644 docs/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md create mode 100644 docs/Riskv1decisionsDeviceInformation.md create mode 100644 docs/Riskv1decisionsMerchantDefinedInformation.md create mode 100644 docs/Riskv1decisionsMerchantInformation.md create mode 100644 docs/Riskv1decisionsMerchantInformationMerchantDescriptor.md create mode 100644 docs/Riskv1decisionsOrderInformation.md create mode 100644 docs/Riskv1decisionsOrderInformationAmountDetails.md create mode 100644 docs/Riskv1decisionsOrderInformationBillTo.md create mode 100644 docs/Riskv1decisionsOrderInformationLineItems.md create mode 100644 docs/Riskv1decisionsOrderInformationShipTo.md create mode 100644 docs/Riskv1decisionsOrderInformationShippingDetails.md create mode 100644 docs/Riskv1decisionsPaymentInformation.md create mode 100644 docs/Riskv1decisionsPaymentInformationCard.md create mode 100644 docs/Riskv1decisionsPaymentInformationTokenizedCard.md create mode 100644 docs/Riskv1decisionsProcessingInformation.md create mode 100644 docs/Riskv1decisionsProcessorInformation.md create mode 100644 docs/Riskv1decisionsProcessorInformationAvs.md create mode 100644 docs/Riskv1decisionsProcessorInformationCardVerification.md create mode 100644 docs/Riskv1decisionsRiskInformation.md create mode 100644 docs/Riskv1decisionsTokenInformation.md create mode 100644 docs/Riskv1decisionsTravelInformation.md create mode 100644 docs/Riskv1decisionsTravelInformationLegs.md create mode 100644 docs/Riskv1decisionsTravelInformationPassengers.md create mode 100644 docs/Riskv1decisionsidactionsDecisionInformation.md create mode 100644 docs/Riskv1decisionsidactionsProcessingInformation.md create mode 100644 docs/Riskv1decisionsidmarkingRiskInformation.md create mode 100644 docs/Riskv1decisionsidmarkingRiskInformationMarkingDetails.md create mode 100644 docs/Riskv1exportcomplianceinquiriesDeviceInformation.md create mode 100644 docs/Riskv1exportcomplianceinquiriesExportComplianceInformation.md create mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformation.md create mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md create mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md create mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md create mode 100644 docs/Riskv1exportcomplianceinquiriesOrderInformationShipTo.md create mode 100644 docs/Riskv1liststypeentriesBuyerInformation.md create mode 100644 docs/Riskv1liststypeentriesClientReferenceInformation.md create mode 100644 docs/Riskv1liststypeentriesDeviceInformation.md create mode 100644 docs/Riskv1liststypeentriesOrderInformation.md create mode 100644 docs/Riskv1liststypeentriesOrderInformationAddress.md create mode 100644 docs/Riskv1liststypeentriesOrderInformationBillTo.md create mode 100644 docs/Riskv1liststypeentriesOrderInformationLineItems.md create mode 100644 docs/Riskv1liststypeentriesOrderInformationShipTo.md create mode 100644 docs/Riskv1liststypeentriesPaymentInformation.md create mode 100644 docs/Riskv1liststypeentriesPaymentInformationBank.md create mode 100644 docs/Riskv1liststypeentriesPaymentInformationCard.md create mode 100644 docs/Riskv1liststypeentriesRiskInformation.md create mode 100644 docs/Riskv1liststypeentriesRiskInformationMarkingDetails.md create mode 100644 docs/SAConfig.md create mode 100644 docs/SAConfigCheckout.md create mode 100644 docs/SAConfigContactInformation.md create mode 100644 docs/SAConfigNotifications.md create mode 100644 docs/SAConfigNotificationsCustomerNotifications.md create mode 100644 docs/SAConfigNotificationsMerchantNotifications.md create mode 100644 docs/SAConfigPaymentMethods.md create mode 100644 docs/SAConfigPaymentTypes.md create mode 100644 docs/SAConfigPaymentTypesCardTypes.md create mode 100644 docs/SAConfigPaymentTypesCardTypesDiscover.md create mode 100644 docs/SAConfigService.md create mode 100644 docs/SaveAsymEgressKey.md create mode 100644 docs/SaveSymEgressKey.md create mode 100644 docs/SearchRequest.md create mode 100644 docs/SearchTransactionsApi.md create mode 100644 docs/SecureFileShareApi.md create mode 100644 docs/ShippingAddressListForCustomer.md create mode 100644 docs/ShippingAddressListForCustomerEmbedded.md create mode 100644 docs/ShippingAddressListForCustomerLinks.md create mode 100644 docs/ShippingAddressListForCustomerLinksFirst.md create mode 100644 docs/ShippingAddressListForCustomerLinksLast.md create mode 100644 docs/ShippingAddressListForCustomerLinksNext.md create mode 100644 docs/ShippingAddressListForCustomerLinksPrev.md create mode 100644 docs/ShippingAddressListForCustomerLinksSelf.md create mode 100644 docs/SubscriptionsApi.md create mode 100644 docs/SubscriptionsFollowOnsApi.md create mode 100644 docs/SuspendSubscriptionResponse.md create mode 100644 docs/SuspendSubscriptionResponseSubscriptionInformation.md create mode 100644 docs/TaxRequest.md create mode 100644 docs/TaxesApi.md create mode 100644 docs/TmsAuthorizationOptions.md create mode 100644 docs/TmsAuthorizationOptionsInitiator.md create mode 100644 docs/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md create mode 100644 docs/TmsBinLookup.md create mode 100644 docs/TmsBinLookupIssuerInformation.md create mode 100644 docs/TmsBinLookupPaymentAccountInformation.md create mode 100644 docs/TmsBinLookupPaymentAccountInformationCard.md create mode 100644 docs/TmsBinLookupPaymentAccountInformationCardBrands.md create mode 100644 docs/TmsBinLookupPaymentAccountInformationFeatures.md create mode 100644 docs/TmsBinLookupPaymentAccountInformationNetwork.md create mode 100644 docs/TmsBusinessInformation.md create mode 100644 docs/TmsBusinessInformationAcquirer.md create mode 100644 docs/TmsBusinessInformationAddress.md create mode 100644 docs/TmsCardArt.md create mode 100644 docs/TmsCardArtBrandLogoAsset.md create mode 100644 docs/TmsCardArtBrandLogoAssetLinks.md create mode 100644 docs/TmsCardArtBrandLogoAssetLinksSelf.md create mode 100644 docs/TmsCardArtCombinedAsset.md create mode 100644 docs/TmsCardArtCombinedAssetLinks.md create mode 100644 docs/TmsCardArtCombinedAssetLinksSelf.md create mode 100644 docs/TmsCardArtIconAsset.md create mode 100644 docs/TmsCardArtIconAssetLinks.md create mode 100644 docs/TmsCardArtIconAssetLinksSelf.md create mode 100644 docs/TmsCardArtIssuerLogoAsset.md create mode 100644 docs/TmsCardArtIssuerLogoAssetLinks.md create mode 100644 docs/TmsCardArtIssuerLogoAssetLinksSelf.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifier.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierBankAccount.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierBillTo.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierCard.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierEmbedded.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierIssuer.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierLinks.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierLinksSelf.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierMetadata.md create mode 100644 docs/TmsEmbeddedInstrumentIdentifierProcessingInformation.md create mode 100644 docs/TmsNetworkTokenServices.md create mode 100644 docs/TmsNetworkTokenServicesAmericanExpressTokenService.md create mode 100644 docs/TmsNetworkTokenServicesMastercardDigitalEnablementService.md create mode 100644 docs/TmsNetworkTokenServicesNotifications.md create mode 100644 docs/TmsNetworkTokenServicesPaymentCredentials.md create mode 100644 docs/TmsNetworkTokenServicesSynchronousProvisioning.md create mode 100644 docs/TmsNetworkTokenServicesVisaTokenService.md create mode 100644 docs/TmsNullify.md create mode 100644 docs/TmsPaymentInstrumentProcessingInfo.md create mode 100644 docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md create mode 100644 docs/TmsSensitivePrivileges.md create mode 100644 docs/TmsTokenFormats.md create mode 100644 docs/Tmsv2TokenizedCard.md create mode 100644 docs/Tmsv2TokenizedCardCard.md create mode 100644 docs/Tmsv2TokenizedCardLinks.md create mode 100644 docs/Tmsv2TokenizedCardLinksSelf.md create mode 100644 docs/Tmsv2TokenizedCardMetadata.md create mode 100644 docs/Tmsv2TokenizedCardMetadataIssuer.md create mode 100644 docs/Tmsv2TokenizedCardPasscode.md create mode 100644 docs/Tmsv2customersBuyerInformation.md create mode 100644 docs/Tmsv2customersClientReferenceInformation.md create mode 100644 docs/Tmsv2customersDefaultPaymentInstrument.md create mode 100644 docs/Tmsv2customersDefaultShippingAddress.md create mode 100644 docs/Tmsv2customersEmbedded.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrument.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddress.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md create mode 100644 docs/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md create mode 100644 docs/Tmsv2customersLinks.md create mode 100644 docs/Tmsv2customersLinksPaymentInstruments.md create mode 100644 docs/Tmsv2customersLinksSelf.md create mode 100644 docs/Tmsv2customersLinksShippingAddress.md create mode 100644 docs/Tmsv2customersMerchantDefinedInformation.md create mode 100644 docs/Tmsv2customersMetadata.md create mode 100644 docs/Tmsv2customersObjectInformation.md create mode 100644 docs/TokenApi.md create mode 100644 docs/TokenPermissions.md create mode 100644 docs/TokenizedCardApi.md create mode 100644 docs/TokenizedcardRequest.md create mode 100644 docs/TransactionBatchesApi.md create mode 100644 docs/TransactionDetailsApi.md create mode 100644 docs/TransientTokenDataApi.md create mode 100644 docs/TssV2GetEmvTags200Response.md create mode 100644 docs/TssV2GetEmvTags200ResponseEmvTagBreakdownList.md create mode 100644 docs/TssV2PostEmvTags200Response.md create mode 100644 docs/TssV2PostEmvTags200ResponseEmvTagBreakdownList.md create mode 100644 docs/TssV2PostEmvTags200ResponseParsedEMVTagsList.md create mode 100644 docs/TssV2TransactionsGet200Response.md create mode 100644 docs/TssV2TransactionsGet200ResponseApplicationInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseApplicationInformationApplications.md create mode 100644 docs/TssV2TransactionsGet200ResponseBankAccountValidation.md create mode 100644 docs/TssV2TransactionsGet200ResponseBuyerInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md create mode 100644 docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md create mode 100644 docs/TssV2TransactionsGet200ResponseDeviceInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseErrorInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseFraudMarkingInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseInstallmentInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseLinks.md create mode 100644 docs/TssV2TransactionsGet200ResponseMerchantInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.md create mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md create mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md create mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.md create mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md create mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md create mode 100644 docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationBrands.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationInvoice.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md create mode 100644 docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md create mode 100644 docs/TssV2TransactionsGet200ResponsePayoutOptions.md create mode 100644 docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessorInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md create mode 100644 docs/TssV2TransactionsGet200ResponseProcessorInformationProcessor.md create mode 100644 docs/TssV2TransactionsGet200ResponseRecurringPaymentInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseRiskInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md create mode 100644 docs/TssV2TransactionsGet200ResponseRiskInformationRules.md create mode 100644 docs/TssV2TransactionsGet200ResponseRiskInformationScore.md create mode 100644 docs/TssV2TransactionsGet200ResponseSenderInformation.md create mode 100644 docs/TssV2TransactionsGet200ResponseTokenInformation.md create mode 100644 docs/TssV2TransactionsPost201Response.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbedded.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedLinks.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md create mode 100644 docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md create mode 100644 docs/Tssv2transactionsemvTagDetailsEmvDetailsList.md create mode 100644 docs/UmsV1UsersGet200Response.md create mode 100644 docs/UmsV1UsersGet200ResponseAccountInformation.md create mode 100644 docs/UmsV1UsersGet200ResponseContactInformation.md create mode 100644 docs/UmsV1UsersGet200ResponseOrganizationInformation.md create mode 100644 docs/UmsV1UsersGet200ResponseUsers.md create mode 100644 docs/UnauthorizedClientError.md create mode 100644 docs/UnifiedCheckoutCaptureContextApi.md create mode 100644 docs/UpdateInvoiceRequest.md create mode 100644 docs/UpdateOrderRequest.md create mode 100644 docs/UpdatePaymentLinkRequest.md create mode 100644 docs/UpdatePlanRequest.md create mode 100644 docs/UpdatePlanResponse.md create mode 100644 docs/UpdatePlanResponsePlanInformation.md create mode 100644 docs/UpdateStatus.md create mode 100644 docs/UpdateSubscription.md create mode 100644 docs/UpdateSubscriptionResponse.md create mode 100644 docs/UpdateWebhook.md create mode 100644 docs/Upv1capturecontextsCaptureMandate.md create mode 100644 docs/Upv1capturecontextsCompleteMandate.md create mode 100644 docs/Upv1capturecontextsOrderInformation.md create mode 100644 docs/Upv1capturecontextsOrderInformationAmountDetails.md create mode 100644 docs/Upv1capturecontextsOrderInformationBillTo.md create mode 100644 docs/Upv1capturecontextsOrderInformationBillToCompany.md create mode 100644 docs/Upv1capturecontextsOrderInformationShipTo.md create mode 100644 docs/UserManagementApi.md create mode 100644 docs/UserManagementSearchApi.md create mode 100644 docs/V1FileDetailsGet200Response.md create mode 100644 docs/V1FileDetailsGet200ResponseFileDetails.md create mode 100644 docs/V1FileDetailsGet200ResponseLinks.md create mode 100644 docs/V1FileDetailsGet200ResponseLinksFiles.md create mode 100644 docs/V1FileDetailsGet200ResponseLinksSelf.md create mode 100644 docs/VTConfig.md create mode 100644 docs/VTConfigCardNotPresent.md create mode 100644 docs/VTConfigCardNotPresentGlobalPaymentInformation.md create mode 100644 docs/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md create mode 100644 docs/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.md create mode 100644 docs/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md create mode 100644 docs/VTConfigCardNotPresentReceiptInformation.md create mode 100644 docs/VTConfigCardNotPresentReceiptInformationEmailReceipt.md create mode 100644 docs/VTConfigCardNotPresentReceiptInformationHeader.md create mode 100644 docs/VTConfigCardNotPresentReceiptInformationOrderInformation.md create mode 100644 docs/ValidateExportComplianceRequest.md create mode 100644 docs/ValidateRequest.md create mode 100644 docs/ValueAddedServicesProducts.md create mode 100644 docs/VasV2PaymentsPost201Response.md create mode 100644 docs/VasV2PaymentsPost201ResponseLinks.md create mode 100644 docs/VasV2PaymentsPost201ResponseOrderInformation.md create mode 100644 docs/VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md create mode 100644 docs/VasV2PaymentsPost201ResponseOrderInformationLineItems.md create mode 100644 docs/VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md create mode 100644 docs/VasV2PaymentsPost201ResponseTaxInformation.md create mode 100644 docs/VasV2PaymentsPost400Response.md create mode 100644 docs/VasV2TaxVoid200Response.md create mode 100644 docs/VasV2TaxVoid200ResponseVoidAmountDetails.md create mode 100644 docs/VasV2TaxVoidsPost400Response.md create mode 100644 docs/Vasv2taxBuyerInformation.md create mode 100644 docs/Vasv2taxClientReferenceInformation.md create mode 100644 docs/Vasv2taxMerchantInformation.md create mode 100644 docs/Vasv2taxOrderInformation.md create mode 100644 docs/Vasv2taxOrderInformationBillTo.md create mode 100644 docs/Vasv2taxOrderInformationInvoiceDetails.md create mode 100644 docs/Vasv2taxOrderInformationLineItems.md create mode 100644 docs/Vasv2taxOrderInformationOrderAcceptance.md create mode 100644 docs/Vasv2taxOrderInformationOrderOrigin.md create mode 100644 docs/Vasv2taxOrderInformationShipTo.md create mode 100644 docs/Vasv2taxOrderInformationShippingDetails.md create mode 100644 docs/Vasv2taxTaxInformation.md create mode 100644 docs/Vasv2taxidClientReferenceInformation.md create mode 100644 docs/Vasv2taxidClientReferenceInformationPartner.md create mode 100644 docs/VerificationApi.md create mode 100644 docs/VerifyCustomerAddressRequest.md create mode 100644 docs/VoidApi.md create mode 100644 docs/VoidCaptureRequest.md create mode 100644 docs/VoidCreditRequest.md create mode 100644 docs/VoidPaymentRequest.md create mode 100644 docs/VoidRefundRequest.md create mode 100644 docs/VoidTaxRequest.md diff --git a/CyberSource/api/batches_api.py b/CyberSource/api/batches_api.py index 3b5f2fd0..4aece210 100644 --- a/CyberSource/api/batches_api.py +++ b/CyberSource/api/batches_api.py @@ -153,6 +153,8 @@ def get_batch_report_with_http_info(self, batch_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_batch_report,get_batch_report_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_batch_report,get_batch_report_with_http_info") + # Authentication setting auth_settings = [] @@ -169,7 +171,8 @@ def get_batch_report_with_http_info(self, batch_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_batch_status(self, batch_id, **kwargs): """ @@ -276,6 +279,8 @@ def get_batch_status_with_http_info(self, batch_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_batch_status,get_batch_status_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_batch_status,get_batch_status_with_http_info") + # Authentication setting auth_settings = [] @@ -292,7 +297,8 @@ def get_batch_status_with_http_info(self, batch_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_batches_list(self, **kwargs): """ @@ -405,6 +411,8 @@ def get_batches_list_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_batches_list,get_batches_list_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_batches_list,get_batches_list_with_http_info") + # Authentication setting auth_settings = [] @@ -421,7 +429,8 @@ def get_batches_list_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_batch(self, body, **kwargs): """ @@ -524,6 +533,8 @@ def post_batch_with_http_info(self, body, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_batch,post_batch_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_batch,post_batch_with_http_info") + # Authentication setting auth_settings = [] @@ -540,4 +551,5 @@ def post_batch_with_http_info(self, body, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/billing_agreements_api.py b/CyberSource/api/billing_agreements_api.py index a96f8052..445360b6 100644 --- a/CyberSource/api/billing_agreements_api.py +++ b/CyberSource/api/billing_agreements_api.py @@ -159,6 +159,8 @@ def billing_agreements_de_registration_with_http_info(self, modify_billing_agree if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "billing_agreements_de_registration,billing_agreements_de_registration_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "billing_agreements_de_registration,billing_agreements_de_registration_with_http_info") + # Authentication setting auth_settings = [] @@ -175,7 +177,8 @@ def billing_agreements_de_registration_with_http_info(self, modify_billing_agree _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def billing_agreements_intimation(self, intimate_billing_agreement, id, **kwargs): """ @@ -288,6 +291,8 @@ def billing_agreements_intimation_with_http_info(self, intimate_billing_agreemen if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "billing_agreements_intimation,billing_agreements_intimation_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "billing_agreements_intimation,billing_agreements_intimation_with_http_info") + # Authentication setting auth_settings = [] @@ -304,7 +309,8 @@ def billing_agreements_intimation_with_http_info(self, intimate_billing_agreemen _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def billing_agreements_registration(self, create_billing_agreement, **kwargs): """ @@ -407,6 +413,8 @@ def billing_agreements_registration_with_http_info(self, create_billing_agreemen if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "billing_agreements_registration,billing_agreements_registration_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "billing_agreements_registration,billing_agreements_registration_with_http_info") + # Authentication setting auth_settings = [] @@ -423,4 +431,5 @@ def billing_agreements_registration_with_http_info(self, create_billing_agreemen _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/bin_lookup_api.py b/CyberSource/api/bin_lookup_api.py index 34bfbfef..7e234360 100644 --- a/CyberSource/api/bin_lookup_api.py +++ b/CyberSource/api/bin_lookup_api.py @@ -152,6 +152,8 @@ def get_account_info_with_http_info(self, create_bin_lookup_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_account_info,get_account_info_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_account_info,get_account_info_with_http_info") + # Authentication setting auth_settings = [] @@ -168,4 +170,5 @@ def get_account_info_with_http_info(self, create_bin_lookup_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/capture_api.py b/CyberSource/api/capture_api.py index 760c963f..e05328fe 100644 --- a/CyberSource/api/capture_api.py +++ b/CyberSource/api/capture_api.py @@ -159,6 +159,8 @@ def capture_payment_with_http_info(self, capture_payment_request, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "capture_payment,capture_payment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "capture_payment,capture_payment_with_http_info") + # Authentication setting auth_settings = [] @@ -175,4 +177,5 @@ def capture_payment_with_http_info(self, capture_payment_request, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/chargeback_details_api.py b/CyberSource/api/chargeback_details_api.py index 24a50c3d..8f2f4661 100644 --- a/CyberSource/api/chargeback_details_api.py +++ b/CyberSource/api/chargeback_details_api.py @@ -165,6 +165,8 @@ def get_chargeback_details_with_http_info(self, start_time, end_time, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_chargeback_details,get_chargeback_details_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_chargeback_details,get_chargeback_details_with_http_info") + # Authentication setting auth_settings = [] @@ -181,4 +183,5 @@ def get_chargeback_details_with_http_info(self, start_time, end_time, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/chargeback_summaries_api.py b/CyberSource/api/chargeback_summaries_api.py index 6c309804..107cee16 100644 --- a/CyberSource/api/chargeback_summaries_api.py +++ b/CyberSource/api/chargeback_summaries_api.py @@ -165,6 +165,8 @@ def get_chargeback_summaries_with_http_info(self, start_time, end_time, **kwargs if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_chargeback_summaries,get_chargeback_summaries_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_chargeback_summaries,get_chargeback_summaries_with_http_info") + # Authentication setting auth_settings = [] @@ -181,4 +183,5 @@ def get_chargeback_summaries_with_http_info(self, start_time, end_time, **kwargs _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/conversion_details_api.py b/CyberSource/api/conversion_details_api.py index 61332df4..edad9850 100644 --- a/CyberSource/api/conversion_details_api.py +++ b/CyberSource/api/conversion_details_api.py @@ -165,6 +165,8 @@ def get_conversion_detail_with_http_info(self, start_time, end_time, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_conversion_detail,get_conversion_detail_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_conversion_detail,get_conversion_detail_with_http_info") + # Authentication setting auth_settings = [] @@ -181,4 +183,5 @@ def get_conversion_detail_with_http_info(self, start_time, end_time, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/create_new_webhooks_api.py b/CyberSource/api/create_new_webhooks_api.py index 9ceedce6..ad2b98a0 100644 --- a/CyberSource/api/create_new_webhooks_api.py +++ b/CyberSource/api/create_new_webhooks_api.py @@ -153,6 +153,8 @@ def find_products_to_subscribe_with_http_info(self, organization_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "find_products_to_subscribe,find_products_to_subscribe_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "find_products_to_subscribe,find_products_to_subscribe_with_http_info") + # Authentication setting auth_settings = [] @@ -169,7 +171,8 @@ def find_products_to_subscribe_with_http_info(self, organization_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def notification_subscriptions_v2_webhooks_post(self, **kwargs): """ @@ -267,6 +270,8 @@ def notification_subscriptions_v2_webhooks_post_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "notification_subscriptions_v2_webhooks_post,notification_subscriptions_v2_webhooks_post_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "notification_subscriptions_v2_webhooks_post,notification_subscriptions_v2_webhooks_post_with_http_info") + # Authentication setting auth_settings = [] @@ -283,7 +288,8 @@ def notification_subscriptions_v2_webhooks_post_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def save_sym_egress_key(self, v_c_sender_organization_id, v_c_permissions, **kwargs): """ @@ -403,6 +409,8 @@ def save_sym_egress_key_with_http_info(self, v_c_sender_organization_id, v_c_per if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "save_sym_egress_key,save_sym_egress_key_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "save_sym_egress_key,save_sym_egress_key_with_http_info") + # Authentication setting auth_settings = [] @@ -419,4 +427,5 @@ def save_sym_egress_key_with_http_info(self, v_c_sender_organization_id, v_c_per _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/credit_api.py b/CyberSource/api/credit_api.py index 4a0f74ce..ff5d8c8f 100644 --- a/CyberSource/api/credit_api.py +++ b/CyberSource/api/credit_api.py @@ -149,6 +149,8 @@ def create_credit_with_http_info(self, create_credit_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_credit,create_credit_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_credit,create_credit_with_http_info") + # Authentication setting auth_settings = [] @@ -165,4 +167,5 @@ def create_credit_with_http_info(self, create_credit_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/customer_api.py b/CyberSource/api/customer_api.py index 9d4791d2..cf9629cb 100644 --- a/CyberSource/api/customer_api.py +++ b/CyberSource/api/customer_api.py @@ -157,6 +157,8 @@ def delete_customer_with_http_info(self, customer_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_customer,delete_customer_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_customer,delete_customer_with_http_info") + # Authentication setting auth_settings = [] @@ -173,7 +175,8 @@ def delete_customer_with_http_info(self, customer_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_customer(self, customer_id, **kwargs): """ @@ -284,6 +287,8 @@ def get_customer_with_http_info(self, customer_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_customer,get_customer_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_customer,get_customer_with_http_info") + # Authentication setting auth_settings = [] @@ -300,7 +305,8 @@ def get_customer_with_http_info(self, customer_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def patch_customer(self, customer_id, patch_customer_request, **kwargs): """ @@ -421,6 +427,8 @@ def patch_customer_with_http_info(self, customer_id, patch_customer_request, **k if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "patch_customer,patch_customer_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "patch_customer,patch_customer_with_http_info") + # Authentication setting auth_settings = [] @@ -437,7 +445,8 @@ def patch_customer_with_http_info(self, customer_id, patch_customer_request, **k _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_customer(self, post_customer_request, **kwargs): """ @@ -544,6 +553,8 @@ def post_customer_with_http_info(self, post_customer_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_customer,post_customer_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_customer,post_customer_with_http_info") + # Authentication setting auth_settings = [] @@ -560,4 +571,5 @@ def post_customer_with_http_info(self, post_customer_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/customer_payment_instrument_api.py b/CyberSource/api/customer_payment_instrument_api.py index e871d5bd..ae03483b 100644 --- a/CyberSource/api/customer_payment_instrument_api.py +++ b/CyberSource/api/customer_payment_instrument_api.py @@ -167,6 +167,8 @@ def delete_customer_payment_instrument_with_http_info(self, customer_id, payment if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_customer_payment_instrument,delete_customer_payment_instrument_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_customer_payment_instrument,delete_customer_payment_instrument_with_http_info") + # Authentication setting auth_settings = [] @@ -183,7 +185,8 @@ def delete_customer_payment_instrument_with_http_info(self, customer_id, payment _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_customer_payment_instrument(self, customer_id, payment_instrument_id, **kwargs): """ @@ -304,6 +307,8 @@ def get_customer_payment_instrument_with_http_info(self, customer_id, payment_in if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_customer_payment_instrument,get_customer_payment_instrument_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_customer_payment_instrument,get_customer_payment_instrument_with_http_info") + # Authentication setting auth_settings = [] @@ -320,7 +325,8 @@ def get_customer_payment_instrument_with_http_info(self, customer_id, payment_in _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_customer_payment_instruments_list(self, customer_id, **kwargs): """ @@ -439,6 +445,8 @@ def get_customer_payment_instruments_list_with_http_info(self, customer_id, **kw if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_customer_payment_instruments_list,get_customer_payment_instruments_list_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_customer_payment_instruments_list,get_customer_payment_instruments_list_with_http_info") + # Authentication setting auth_settings = [] @@ -455,7 +463,8 @@ def get_customer_payment_instruments_list_with_http_info(self, customer_id, **kw _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def patch_customers_payment_instrument(self, customer_id, payment_instrument_id, patch_customer_payment_instrument_request, **kwargs): """ @@ -586,6 +595,8 @@ def patch_customers_payment_instrument_with_http_info(self, customer_id, payment if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "patch_customers_payment_instrument,patch_customers_payment_instrument_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "patch_customers_payment_instrument,patch_customers_payment_instrument_with_http_info") + # Authentication setting auth_settings = [] @@ -602,7 +613,8 @@ def patch_customers_payment_instrument_with_http_info(self, customer_id, payment _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_customer_payment_instrument(self, customer_id, post_customer_payment_instrument_request, **kwargs): """ @@ -719,6 +731,8 @@ def post_customer_payment_instrument_with_http_info(self, customer_id, post_cust if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_customer_payment_instrument,post_customer_payment_instrument_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_customer_payment_instrument,post_customer_payment_instrument_with_http_info") + # Authentication setting auth_settings = [] @@ -735,4 +749,5 @@ def post_customer_payment_instrument_with_http_info(self, customer_id, post_cust _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/customer_shipping_address_api.py b/CyberSource/api/customer_shipping_address_api.py index cce46b26..c24d881c 100644 --- a/CyberSource/api/customer_shipping_address_api.py +++ b/CyberSource/api/customer_shipping_address_api.py @@ -167,6 +167,8 @@ def delete_customer_shipping_address_with_http_info(self, customer_id, shipping_ if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_customer_shipping_address,delete_customer_shipping_address_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_customer_shipping_address,delete_customer_shipping_address_with_http_info") + # Authentication setting auth_settings = [] @@ -183,7 +185,8 @@ def delete_customer_shipping_address_with_http_info(self, customer_id, shipping_ _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_customer_shipping_address(self, customer_id, shipping_address_id, **kwargs): """ @@ -304,6 +307,8 @@ def get_customer_shipping_address_with_http_info(self, customer_id, shipping_add if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_customer_shipping_address,get_customer_shipping_address_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_customer_shipping_address,get_customer_shipping_address_with_http_info") + # Authentication setting auth_settings = [] @@ -320,7 +325,8 @@ def get_customer_shipping_address_with_http_info(self, customer_id, shipping_add _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_customer_shipping_addresses_list(self, customer_id, **kwargs): """ @@ -439,6 +445,8 @@ def get_customer_shipping_addresses_list_with_http_info(self, customer_id, **kwa if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_customer_shipping_addresses_list,get_customer_shipping_addresses_list_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_customer_shipping_addresses_list,get_customer_shipping_addresses_list_with_http_info") + # Authentication setting auth_settings = [] @@ -455,7 +463,8 @@ def get_customer_shipping_addresses_list_with_http_info(self, customer_id, **kwa _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def patch_customers_shipping_address(self, customer_id, shipping_address_id, patch_customer_shipping_address_request, **kwargs): """ @@ -586,6 +595,8 @@ def patch_customers_shipping_address_with_http_info(self, customer_id, shipping_ if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "patch_customers_shipping_address,patch_customers_shipping_address_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "patch_customers_shipping_address,patch_customers_shipping_address_with_http_info") + # Authentication setting auth_settings = [] @@ -602,7 +613,8 @@ def patch_customers_shipping_address_with_http_info(self, customer_id, shipping_ _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_customer_shipping_address(self, customer_id, post_customer_shipping_address_request, **kwargs): """ @@ -719,6 +731,8 @@ def post_customer_shipping_address_with_http_info(self, customer_id, post_custom if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_customer_shipping_address,post_customer_shipping_address_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_customer_shipping_address,post_customer_shipping_address_with_http_info") + # Authentication setting auth_settings = [] @@ -735,4 +749,5 @@ def post_customer_shipping_address_with_http_info(self, customer_id, post_custom _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/decision_manager_api.py b/CyberSource/api/decision_manager_api.py index 96d2cfbe..625db34f 100644 --- a/CyberSource/api/decision_manager_api.py +++ b/CyberSource/api/decision_manager_api.py @@ -159,6 +159,8 @@ def action_decision_manager_case_with_http_info(self, id, case_management_action if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "action_decision_manager_case,action_decision_manager_case_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "action_decision_manager_case,action_decision_manager_case_with_http_info") + # Authentication setting auth_settings = [] @@ -175,7 +177,8 @@ def action_decision_manager_case_with_http_info(self, id, case_management_action _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def add_negative(self, type, add_negative_list_request, **kwargs): """ @@ -288,6 +291,8 @@ def add_negative_with_http_info(self, type, add_negative_list_request, **kwargs) if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "add_negative,add_negative_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "add_negative,add_negative_with_http_info") + # Authentication setting auth_settings = [] @@ -304,7 +309,8 @@ def add_negative_with_http_info(self, type, add_negative_list_request, **kwargs) _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def comment_decision_manager_case(self, id, case_management_comments_request, **kwargs): """ @@ -417,6 +423,8 @@ def comment_decision_manager_case_with_http_info(self, id, case_management_comme if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "comment_decision_manager_case,comment_decision_manager_case_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "comment_decision_manager_case,comment_decision_manager_case_with_http_info") + # Authentication setting auth_settings = [] @@ -433,7 +441,8 @@ def comment_decision_manager_case_with_http_info(self, id, case_management_comme _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def create_bundled_decision_manager_case(self, create_bundled_decision_manager_case_request, **kwargs): """ @@ -536,6 +545,8 @@ def create_bundled_decision_manager_case_with_http_info(self, create_bundled_dec if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_bundled_decision_manager_case,create_bundled_decision_manager_case_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_bundled_decision_manager_case,create_bundled_decision_manager_case_with_http_info") + # Authentication setting auth_settings = [] @@ -552,7 +563,8 @@ def create_bundled_decision_manager_case_with_http_info(self, create_bundled_dec _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def fraud_update(self, id, fraud_marking_action_request, **kwargs): """ @@ -665,6 +677,8 @@ def fraud_update_with_http_info(self, id, fraud_marking_action_request, **kwargs if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "fraud_update,fraud_update_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "fraud_update,fraud_update_with_http_info") + # Authentication setting auth_settings = [] @@ -681,4 +695,5 @@ def fraud_update_with_http_info(self, id, fraud_marking_action_request, **kwargs _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/device_de_association_api.py b/CyberSource/api/device_de_association_api.py index e7d0fbb1..f8f4edb1 100644 --- a/CyberSource/api/device_de_association_api.py +++ b/CyberSource/api/device_de_association_api.py @@ -149,6 +149,8 @@ def delete_terminal_association_with_http_info(self, de_association_request_body if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_terminal_association,delete_terminal_association_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_terminal_association,delete_terminal_association_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def delete_terminal_association_with_http_info(self, de_association_request_body _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_de_associate_v3_terminal(self, device_de_associate_v3_request, **kwargs): """ @@ -268,6 +271,8 @@ def post_de_associate_v3_terminal_with_http_info(self, device_de_associate_v3_re if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_de_associate_v3_terminal,post_de_associate_v3_terminal_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_de_associate_v3_terminal,post_de_associate_v3_terminal_with_http_info") + # Authentication setting auth_settings = [] @@ -284,4 +289,5 @@ def post_de_associate_v3_terminal_with_http_info(self, device_de_associate_v3_re _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/device_search_api.py b/CyberSource/api/device_search_api.py index 5ade53d7..7578eaa3 100644 --- a/CyberSource/api/device_search_api.py +++ b/CyberSource/api/device_search_api.py @@ -149,6 +149,8 @@ def post_search_query_with_http_info(self, post_device_search_request, **kwargs) if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_search_query,post_search_query_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_search_query,post_search_query_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def post_search_query_with_http_info(self, post_device_search_request, **kwargs) _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_search_query_v3(self, post_device_search_request_v3, **kwargs): """ @@ -268,6 +271,8 @@ def post_search_query_v3_with_http_info(self, post_device_search_request_v3, **k if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_search_query_v3,post_search_query_v3_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_search_query_v3,post_search_query_v3_with_http_info") + # Authentication setting auth_settings = [] @@ -284,4 +289,5 @@ def post_search_query_v3_with_http_info(self, post_device_search_request_v3, **k _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/download_dtd_api.py b/CyberSource/api/download_dtd_api.py index 03af1078..a6b36927 100644 --- a/CyberSource/api/download_dtd_api.py +++ b/CyberSource/api/download_dtd_api.py @@ -153,6 +153,8 @@ def get_dtdv2_with_http_info(self, report_definition_name_version, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_dtdv2,get_dtdv2_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_dtdv2,get_dtdv2_with_http_info") + # Authentication setting auth_settings = [] @@ -169,4 +171,5 @@ def get_dtdv2_with_http_info(self, report_definition_name_version, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/download_xsd_api.py b/CyberSource/api/download_xsd_api.py index 6f573d32..636a36e7 100644 --- a/CyberSource/api/download_xsd_api.py +++ b/CyberSource/api/download_xsd_api.py @@ -153,6 +153,8 @@ def get_xsdv2_with_http_info(self, report_definition_name_version, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_xsdv2,get_xsdv2_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_xsdv2,get_xsdv2_with_http_info") + # Authentication setting auth_settings = [] @@ -169,4 +171,5 @@ def get_xsdv2_with_http_info(self, report_definition_name_version, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/emv_tag_details_api.py b/CyberSource/api/emv_tag_details_api.py index 382124b1..f220609d 100644 --- a/CyberSource/api/emv_tag_details_api.py +++ b/CyberSource/api/emv_tag_details_api.py @@ -142,6 +142,8 @@ def get_emv_tags_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_emv_tags,get_emv_tags_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_emv_tags,get_emv_tags_with_http_info") + # Authentication setting auth_settings = [] @@ -158,7 +160,8 @@ def get_emv_tags_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def parse_emv_tags(self, body, **kwargs): """ @@ -261,6 +264,8 @@ def parse_emv_tags_with_http_info(self, body, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "parse_emv_tags,parse_emv_tags_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "parse_emv_tags,parse_emv_tags_with_http_info") + # Authentication setting auth_settings = [] @@ -277,4 +282,5 @@ def parse_emv_tags_with_http_info(self, body, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/flex_api_api.py b/CyberSource/api/flex_api_api.py index a5e74408..2fffffaa 100644 --- a/CyberSource/api/flex_api_api.py +++ b/CyberSource/api/flex_api_api.py @@ -149,6 +149,8 @@ def generate_flex_api_capture_context_with_http_info(self, generate_flex_api_cap if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "generate_flex_api_capture_context,generate_flex_api_capture_context_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "generate_flex_api_capture_context,generate_flex_api_capture_context_with_http_info") + # Authentication setting auth_settings = [] @@ -165,4 +167,5 @@ def generate_flex_api_capture_context_with_http_info(self, generate_flex_api_cap _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/instrument_identifier_api.py b/CyberSource/api/instrument_identifier_api.py index 9bae3f9b..d27adfc7 100644 --- a/CyberSource/api/instrument_identifier_api.py +++ b/CyberSource/api/instrument_identifier_api.py @@ -157,6 +157,8 @@ def delete_instrument_identifier_with_http_info(self, instrument_identifier_id, if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_instrument_identifier,delete_instrument_identifier_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_instrument_identifier,delete_instrument_identifier_with_http_info") + # Authentication setting auth_settings = [] @@ -173,7 +175,8 @@ def delete_instrument_identifier_with_http_info(self, instrument_identifier_id, _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_instrument_identifier(self, instrument_identifier_id, **kwargs): """ @@ -288,6 +291,8 @@ def get_instrument_identifier_with_http_info(self, instrument_identifier_id, **k if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_instrument_identifier,get_instrument_identifier_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_instrument_identifier,get_instrument_identifier_with_http_info") + # Authentication setting auth_settings = [] @@ -304,7 +309,8 @@ def get_instrument_identifier_with_http_info(self, instrument_identifier_id, **k _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_instrument_identifier_payment_instruments_list(self, instrument_identifier_id, **kwargs): """ @@ -427,6 +433,8 @@ def get_instrument_identifier_payment_instruments_list_with_http_info(self, inst if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_instrument_identifier_payment_instruments_list,get_instrument_identifier_payment_instruments_list_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_instrument_identifier_payment_instruments_list,get_instrument_identifier_payment_instruments_list_with_http_info") + # Authentication setting auth_settings = [] @@ -443,7 +451,8 @@ def get_instrument_identifier_payment_instruments_list_with_http_info(self, inst _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def patch_instrument_identifier(self, instrument_identifier_id, patch_instrument_identifier_request, **kwargs): """ @@ -568,6 +577,8 @@ def patch_instrument_identifier_with_http_info(self, instrument_identifier_id, p if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "patch_instrument_identifier,patch_instrument_identifier_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "patch_instrument_identifier,patch_instrument_identifier_with_http_info") + # Authentication setting auth_settings = [] @@ -584,7 +595,8 @@ def patch_instrument_identifier_with_http_info(self, instrument_identifier_id, p _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_instrument_identifier(self, post_instrument_identifier_request, **kwargs): """ @@ -695,6 +707,8 @@ def post_instrument_identifier_with_http_info(self, post_instrument_identifier_r if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_instrument_identifier,post_instrument_identifier_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_instrument_identifier,post_instrument_identifier_with_http_info") + # Authentication setting auth_settings = [] @@ -711,7 +725,8 @@ def post_instrument_identifier_with_http_info(self, post_instrument_identifier_r _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_instrument_identifier_enrollment(self, instrument_identifier_id, post_instrument_identifier_enrollment_request, **kwargs): """ @@ -828,6 +843,8 @@ def post_instrument_identifier_enrollment_with_http_info(self, instrument_identi if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_instrument_identifier_enrollment,post_instrument_identifier_enrollment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_instrument_identifier_enrollment,post_instrument_identifier_enrollment_with_http_info") + # Authentication setting auth_settings = [] @@ -844,4 +861,5 @@ def post_instrument_identifier_enrollment_with_http_info(self, instrument_identi _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/interchange_clearing_level_details_api.py b/CyberSource/api/interchange_clearing_level_details_api.py index e7423619..bd2d658a 100644 --- a/CyberSource/api/interchange_clearing_level_details_api.py +++ b/CyberSource/api/interchange_clearing_level_details_api.py @@ -165,6 +165,8 @@ def get_interchange_clearing_level_details_with_http_info(self, start_time, end_ if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_interchange_clearing_level_details,get_interchange_clearing_level_details_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_interchange_clearing_level_details,get_interchange_clearing_level_details_with_http_info") + # Authentication setting auth_settings = [] @@ -181,4 +183,5 @@ def get_interchange_clearing_level_details_with_http_info(self, start_time, end_ _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/invoice_settings_api.py b/CyberSource/api/invoice_settings_api.py index 54bb5ad9..31b9f4ff 100644 --- a/CyberSource/api/invoice_settings_api.py +++ b/CyberSource/api/invoice_settings_api.py @@ -142,6 +142,8 @@ def get_invoice_settings_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_invoice_settings,get_invoice_settings_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_invoice_settings,get_invoice_settings_with_http_info") + # Authentication setting auth_settings = [] @@ -158,7 +160,8 @@ def get_invoice_settings_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def update_invoice_settings(self, invoice_settings_request, **kwargs): """ @@ -261,6 +264,8 @@ def update_invoice_settings_with_http_info(self, invoice_settings_request, **kwa if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "update_invoice_settings,update_invoice_settings_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "update_invoice_settings,update_invoice_settings_with_http_info") + # Authentication setting auth_settings = [] @@ -277,4 +282,5 @@ def update_invoice_settings_with_http_info(self, invoice_settings_request, **kwa _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/invoices_api.py b/CyberSource/api/invoices_api.py index af384f48..199988a3 100644 --- a/CyberSource/api/invoices_api.py +++ b/CyberSource/api/invoices_api.py @@ -149,6 +149,8 @@ def create_invoice_with_http_info(self, create_invoice_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_invoice,create_invoice_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_invoice,create_invoice_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def create_invoice_with_http_info(self, create_invoice_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_all_invoices(self, offset, limit, **kwargs): """ @@ -284,6 +287,8 @@ def get_all_invoices_with_http_info(self, offset, limit, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_all_invoices,get_all_invoices_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_all_invoices,get_all_invoices_with_http_info") + # Authentication setting auth_settings = [] @@ -300,7 +305,8 @@ def get_all_invoices_with_http_info(self, offset, limit, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_invoice(self, id, **kwargs): """ @@ -407,6 +413,8 @@ def get_invoice_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_invoice,get_invoice_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_invoice,get_invoice_with_http_info") + # Authentication setting auth_settings = [] @@ -423,7 +431,8 @@ def get_invoice_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def perform_cancel_action(self, id, **kwargs): """ @@ -530,6 +539,8 @@ def perform_cancel_action_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "perform_cancel_action,perform_cancel_action_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "perform_cancel_action,perform_cancel_action_with_http_info") + # Authentication setting auth_settings = [] @@ -546,7 +557,8 @@ def perform_cancel_action_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def perform_publish_action(self, id, **kwargs): """ @@ -653,6 +665,8 @@ def perform_publish_action_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "perform_publish_action,perform_publish_action_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "perform_publish_action,perform_publish_action_with_http_info") + # Authentication setting auth_settings = [] @@ -669,7 +683,8 @@ def perform_publish_action_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def perform_send_action(self, id, **kwargs): """ @@ -776,6 +791,8 @@ def perform_send_action_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "perform_send_action,perform_send_action_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "perform_send_action,perform_send_action_with_http_info") + # Authentication setting auth_settings = [] @@ -792,7 +809,8 @@ def perform_send_action_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def update_invoice(self, id, update_invoice_request, **kwargs): """ @@ -905,6 +923,8 @@ def update_invoice_with_http_info(self, id, update_invoice_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "update_invoice,update_invoice_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "update_invoice,update_invoice_with_http_info") + # Authentication setting auth_settings = [] @@ -921,4 +941,5 @@ def update_invoice_with_http_info(self, id, update_invoice_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/manage_webhooks_api.py b/CyberSource/api/manage_webhooks_api.py index a5eecb33..4d6050ec 100644 --- a/CyberSource/api/manage_webhooks_api.py +++ b/CyberSource/api/manage_webhooks_api.py @@ -153,6 +153,8 @@ def delete_webhook_subscription_with_http_info(self, webhook_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_webhook_subscription,delete_webhook_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_webhook_subscription,delete_webhook_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -169,7 +171,8 @@ def delete_webhook_subscription_with_http_info(self, webhook_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_webhook_subscription_by_id(self, webhook_id, **kwargs): """ @@ -276,6 +279,8 @@ def get_webhook_subscription_by_id_with_http_info(self, webhook_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_webhook_subscription_by_id,get_webhook_subscription_by_id_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_webhook_subscription_by_id,get_webhook_subscription_by_id_with_http_info") + # Authentication setting auth_settings = [] @@ -292,7 +297,8 @@ def get_webhook_subscription_by_id_with_http_info(self, webhook_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_webhook_subscriptions_by_org(self, organization_id, **kwargs): """ @@ -406,6 +412,8 @@ def get_webhook_subscriptions_by_org_with_http_info(self, organization_id, **kwa if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_webhook_subscriptions_by_org,get_webhook_subscriptions_by_org_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_webhook_subscriptions_by_org,get_webhook_subscriptions_by_org_with_http_info") + # Authentication setting auth_settings = [] @@ -422,7 +430,8 @@ def get_webhook_subscriptions_by_org_with_http_info(self, organization_id, **kwa _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def notification_subscriptions_v1_webhooks_webhook_id_post(self, webhook_id, **kwargs): """ @@ -529,6 +538,8 @@ def notification_subscriptions_v1_webhooks_webhook_id_post_with_http_info(self, if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "notification_subscriptions_v1_webhooks_webhook_id_post,notification_subscriptions_v1_webhooks_webhook_id_post_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "notification_subscriptions_v1_webhooks_webhook_id_post,notification_subscriptions_v1_webhooks_webhook_id_post_with_http_info") + # Authentication setting auth_settings = [] @@ -545,7 +556,8 @@ def notification_subscriptions_v1_webhooks_webhook_id_post_with_http_info(self, _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def notification_subscriptions_v2_webhooks_webhook_id_patch(self, webhook_id, **kwargs): """ @@ -653,6 +665,8 @@ def notification_subscriptions_v2_webhooks_webhook_id_patch_with_http_info(self, if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "notification_subscriptions_v2_webhooks_webhook_id_patch,notification_subscriptions_v2_webhooks_webhook_id_patch_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "notification_subscriptions_v2_webhooks_webhook_id_patch,notification_subscriptions_v2_webhooks_webhook_id_patch_with_http_info") + # Authentication setting auth_settings = [] @@ -669,7 +683,8 @@ def notification_subscriptions_v2_webhooks_webhook_id_patch_with_http_info(self, _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def notification_subscriptions_v2_webhooks_webhook_id_status_put(self, webhook_id, **kwargs): """ @@ -777,6 +792,8 @@ def notification_subscriptions_v2_webhooks_webhook_id_status_put_with_http_info( if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "notification_subscriptions_v2_webhooks_webhook_id_status_put,notification_subscriptions_v2_webhooks_webhook_id_status_put_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "notification_subscriptions_v2_webhooks_webhook_id_status_put,notification_subscriptions_v2_webhooks_webhook_id_status_put_with_http_info") + # Authentication setting auth_settings = [] @@ -793,7 +810,8 @@ def notification_subscriptions_v2_webhooks_webhook_id_status_put_with_http_info( _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def save_asym_egress_key(self, v_c_sender_organization_id, v_c_permissions, save_asym_egress_key, **kwargs): """ @@ -918,6 +936,8 @@ def save_asym_egress_key_with_http_info(self, v_c_sender_organization_id, v_c_pe if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "save_asym_egress_key,save_asym_egress_key_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "save_asym_egress_key,save_asym_egress_key_with_http_info") + # Authentication setting auth_settings = [] @@ -934,4 +954,5 @@ def save_asym_egress_key_with_http_info(self, v_c_sender_organization_id, v_c_pe _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/merchant_boarding_api.py b/CyberSource/api/merchant_boarding_api.py index 84c51df7..2aa1a346 100644 --- a/CyberSource/api/merchant_boarding_api.py +++ b/CyberSource/api/merchant_boarding_api.py @@ -153,6 +153,8 @@ def get_registration_with_http_info(self, registration_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_registration,get_registration_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_registration,get_registration_with_http_info") + # Authentication setting auth_settings = [] @@ -169,7 +171,8 @@ def get_registration_with_http_info(self, registration_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_registration(self, post_registration_body, **kwargs): """ @@ -276,6 +279,8 @@ def post_registration_with_http_info(self, post_registration_body, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_registration,post_registration_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_registration,post_registration_with_http_info") + # Authentication setting auth_settings = [] @@ -292,4 +297,5 @@ def post_registration_with_http_info(self, post_registration_body, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/microform_integration_api.py b/CyberSource/api/microform_integration_api.py index 5b9fc775..10208486 100644 --- a/CyberSource/api/microform_integration_api.py +++ b/CyberSource/api/microform_integration_api.py @@ -149,6 +149,8 @@ def generate_capture_context_with_http_info(self, generate_capture_context_reque if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "generate_capture_context,generate_capture_context_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "generate_capture_context,generate_capture_context_with_http_info") + # Authentication setting auth_settings = [] @@ -165,4 +167,5 @@ def generate_capture_context_with_http_info(self, generate_capture_context_reque _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/net_fundings_api.py b/CyberSource/api/net_fundings_api.py index 110b32ee..1e7fb4df 100644 --- a/CyberSource/api/net_fundings_api.py +++ b/CyberSource/api/net_fundings_api.py @@ -169,6 +169,8 @@ def get_net_funding_details_with_http_info(self, start_time, end_time, **kwargs) if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_net_funding_details,get_net_funding_details_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_net_funding_details,get_net_funding_details_with_http_info") + # Authentication setting auth_settings = [] @@ -185,4 +187,5 @@ def get_net_funding_details_with_http_info(self, start_time, end_time, **kwargs) _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/notification_of_changes_api.py b/CyberSource/api/notification_of_changes_api.py index 206fd2d8..0b9069d8 100644 --- a/CyberSource/api/notification_of_changes_api.py +++ b/CyberSource/api/notification_of_changes_api.py @@ -161,6 +161,8 @@ def get_notification_of_change_report_with_http_info(self, start_time, end_time, if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_notification_of_change_report,get_notification_of_change_report_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_notification_of_change_report,get_notification_of_change_report_with_http_info") + # Authentication setting auth_settings = [] @@ -177,4 +179,5 @@ def get_notification_of_change_report_with_http_info(self, start_time, end_time, _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/orders_api.py b/CyberSource/api/orders_api.py index 59758ea1..a76e774c 100644 --- a/CyberSource/api/orders_api.py +++ b/CyberSource/api/orders_api.py @@ -149,6 +149,8 @@ def create_order_with_http_info(self, create_order_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_order,create_order_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_order,create_order_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def create_order_with_http_info(self, create_order_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def update_order(self, id, update_order_request, **kwargs): """ @@ -278,6 +281,8 @@ def update_order_with_http_info(self, id, update_order_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "update_order,update_order_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "update_order,update_order_with_http_info") + # Authentication setting auth_settings = [] @@ -294,4 +299,5 @@ def update_order_with_http_info(self, id, update_order_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/payer_authentication_api.py b/CyberSource/api/payer_authentication_api.py index ca530907..8fb7574b 100644 --- a/CyberSource/api/payer_authentication_api.py +++ b/CyberSource/api/payer_authentication_api.py @@ -149,6 +149,8 @@ def check_payer_auth_enrollment_with_http_info(self, check_payer_auth_enrollment if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "check_payer_auth_enrollment,check_payer_auth_enrollment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "check_payer_auth_enrollment,check_payer_auth_enrollment_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def check_payer_auth_enrollment_with_http_info(self, check_payer_auth_enrollment _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def payer_auth_setup(self, payer_auth_setup_request, **kwargs): """ @@ -268,6 +271,8 @@ def payer_auth_setup_with_http_info(self, payer_auth_setup_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "payer_auth_setup,payer_auth_setup_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "payer_auth_setup,payer_auth_setup_with_http_info") + # Authentication setting auth_settings = [] @@ -284,7 +289,8 @@ def payer_auth_setup_with_http_info(self, payer_auth_setup_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def validate_authentication_results(self, validate_request, **kwargs): """ @@ -387,6 +393,8 @@ def validate_authentication_results_with_http_info(self, validate_request, **kwa if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "validate_authentication_results,validate_authentication_results_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "validate_authentication_results,validate_authentication_results_with_http_info") + # Authentication setting auth_settings = [] @@ -403,4 +411,5 @@ def validate_authentication_results_with_http_info(self, validate_request, **kwa _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/payment_batch_summaries_api.py b/CyberSource/api/payment_batch_summaries_api.py index 595e85d1..8eaa948d 100644 --- a/CyberSource/api/payment_batch_summaries_api.py +++ b/CyberSource/api/payment_batch_summaries_api.py @@ -177,6 +177,8 @@ def get_payment_batch_summary_with_http_info(self, start_time, end_time, **kwarg if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_payment_batch_summary,get_payment_batch_summary_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_payment_batch_summary,get_payment_batch_summary_with_http_info") + # Authentication setting auth_settings = [] @@ -193,4 +195,5 @@ def get_payment_batch_summary_with_http_info(self, start_time, end_time, **kwarg _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/payment_instrument_api.py b/CyberSource/api/payment_instrument_api.py index 07542064..073920f1 100644 --- a/CyberSource/api/payment_instrument_api.py +++ b/CyberSource/api/payment_instrument_api.py @@ -157,6 +157,8 @@ def delete_payment_instrument_with_http_info(self, payment_instrument_id, **kwar if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_payment_instrument,delete_payment_instrument_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_payment_instrument,delete_payment_instrument_with_http_info") + # Authentication setting auth_settings = [] @@ -173,7 +175,8 @@ def delete_payment_instrument_with_http_info(self, payment_instrument_id, **kwar _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_payment_instrument(self, payment_instrument_id, **kwargs): """ @@ -288,6 +291,8 @@ def get_payment_instrument_with_http_info(self, payment_instrument_id, **kwargs) if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_payment_instrument,get_payment_instrument_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_payment_instrument,get_payment_instrument_with_http_info") + # Authentication setting auth_settings = [] @@ -304,7 +309,8 @@ def get_payment_instrument_with_http_info(self, payment_instrument_id, **kwargs) _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def patch_payment_instrument(self, payment_instrument_id, patch_payment_instrument_request, **kwargs): """ @@ -429,6 +435,8 @@ def patch_payment_instrument_with_http_info(self, payment_instrument_id, patch_p if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "patch_payment_instrument,patch_payment_instrument_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "patch_payment_instrument,patch_payment_instrument_with_http_info") + # Authentication setting auth_settings = [] @@ -445,7 +453,8 @@ def patch_payment_instrument_with_http_info(self, payment_instrument_id, patch_p _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_payment_instrument(self, post_payment_instrument_request, **kwargs): """ @@ -556,6 +565,8 @@ def post_payment_instrument_with_http_info(self, post_payment_instrument_request if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_payment_instrument,post_payment_instrument_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_payment_instrument,post_payment_instrument_with_http_info") + # Authentication setting auth_settings = [] @@ -572,4 +583,5 @@ def post_payment_instrument_with_http_info(self, post_payment_instrument_request _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/payment_links_api.py b/CyberSource/api/payment_links_api.py index 6b6a3a80..c3e4f863 100644 --- a/CyberSource/api/payment_links_api.py +++ b/CyberSource/api/payment_links_api.py @@ -149,6 +149,8 @@ def create_payment_link_with_http_info(self, create_payment_link_request, **kwar if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_payment_link,create_payment_link_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_payment_link,create_payment_link_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def create_payment_link_with_http_info(self, create_payment_link_request, **kwar _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_all_payment_links(self, offset, limit, **kwargs): """ @@ -284,6 +287,8 @@ def get_all_payment_links_with_http_info(self, offset, limit, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_all_payment_links,get_all_payment_links_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_all_payment_links,get_all_payment_links_with_http_info") + # Authentication setting auth_settings = [] @@ -300,7 +305,8 @@ def get_all_payment_links_with_http_info(self, offset, limit, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_payment_link(self, id, **kwargs): """ @@ -407,6 +413,8 @@ def get_payment_link_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_payment_link,get_payment_link_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_payment_link,get_payment_link_with_http_info") + # Authentication setting auth_settings = [] @@ -423,7 +431,8 @@ def get_payment_link_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def update_payment_link(self, id, update_payment_link_request, **kwargs): """ @@ -536,6 +545,8 @@ def update_payment_link_with_http_info(self, id, update_payment_link_request, ** if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "update_payment_link,update_payment_link_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "update_payment_link,update_payment_link_with_http_info") + # Authentication setting auth_settings = [] @@ -552,4 +563,5 @@ def update_payment_link_with_http_info(self, id, update_payment_link_request, ** _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/payment_tokens_api.py b/CyberSource/api/payment_tokens_api.py index 461b8ac2..2695904b 100644 --- a/CyberSource/api/payment_tokens_api.py +++ b/CyberSource/api/payment_tokens_api.py @@ -149,6 +149,8 @@ def retrieve_or_delete_payment_token_with_http_info(self, request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "retrieve_or_delete_payment_token,retrieve_or_delete_payment_token_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "retrieve_or_delete_payment_token,retrieve_or_delete_payment_token_with_http_info") + # Authentication setting auth_settings = [] @@ -165,4 +167,5 @@ def retrieve_or_delete_payment_token_with_http_info(self, request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/payments_api.py b/CyberSource/api/payments_api.py index cf663682..f1669ebd 100644 --- a/CyberSource/api/payments_api.py +++ b/CyberSource/api/payments_api.py @@ -159,6 +159,8 @@ def create_order_request_with_http_info(self, order_payment_request, id, **kwarg if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_order_request,create_order_request_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_order_request,create_order_request_with_http_info") + # Authentication setting auth_settings = [] @@ -175,7 +177,8 @@ def create_order_request_with_http_info(self, order_payment_request, id, **kwarg _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def create_payment(self, create_payment_request, **kwargs): """ @@ -277,7 +280,9 @@ def create_payment_with_http_info(self, create_payment_request, **kwargs): inbound_mle_status = "optional" if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_payment,create_payment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_payment,create_payment_with_http_info") + # Authentication setting auth_settings = [] @@ -398,6 +403,8 @@ def create_session_request_with_http_info(self, create_session_req, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_session_request,create_session_request_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_session_request,create_session_request_with_http_info") + # Authentication setting auth_settings = [] @@ -414,7 +421,8 @@ def create_session_request_with_http_info(self, create_session_req, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def increment_auth(self, id, increment_auth_request, **kwargs): """ @@ -527,6 +535,8 @@ def increment_auth_with_http_info(self, id, increment_auth_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "increment_auth,increment_auth_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "increment_auth,increment_auth_with_http_info") + # Authentication setting auth_settings = [] @@ -543,7 +553,8 @@ def increment_auth_with_http_info(self, id, increment_auth_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def refresh_payment_status(self, id, refresh_payment_status_request, **kwargs): """ @@ -656,6 +667,8 @@ def refresh_payment_status_with_http_info(self, id, refresh_payment_status_reque if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "refresh_payment_status,refresh_payment_status_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "refresh_payment_status,refresh_payment_status_with_http_info") + # Authentication setting auth_settings = [] @@ -672,7 +685,8 @@ def refresh_payment_status_with_http_info(self, id, refresh_payment_status_reque _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def update_session_req(self, create_session_request, id, **kwargs): """ @@ -785,6 +799,8 @@ def update_session_req_with_http_info(self, create_session_request, id, **kwargs if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "update_session_req,update_session_req_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "update_session_req,update_session_req_with_http_info") + # Authentication setting auth_settings = [] @@ -801,4 +817,5 @@ def update_session_req_with_http_info(self, create_session_request, id, **kwargs _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/payouts_api.py b/CyberSource/api/payouts_api.py index e8ac22b4..e1a26554 100644 --- a/CyberSource/api/payouts_api.py +++ b/CyberSource/api/payouts_api.py @@ -149,6 +149,8 @@ def oct_create_payment_with_http_info(self, oct_create_payment_request, **kwargs if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "oct_create_payment,oct_create_payment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "oct_create_payment,oct_create_payment_with_http_info") + # Authentication setting auth_settings = [] @@ -165,4 +167,5 @@ def oct_create_payment_with_http_info(self, oct_create_payment_request, **kwargs _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/plans_api.py b/CyberSource/api/plans_api.py index 1aa0dadf..c13ae22e 100644 --- a/CyberSource/api/plans_api.py +++ b/CyberSource/api/plans_api.py @@ -153,6 +153,8 @@ def activate_plan_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "activate_plan,activate_plan_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "activate_plan,activate_plan_with_http_info") + # Authentication setting auth_settings = [] @@ -169,7 +171,8 @@ def activate_plan_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def create_plan(self, create_plan_request, **kwargs): """ @@ -272,6 +275,8 @@ def create_plan_with_http_info(self, create_plan_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_plan,create_plan_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_plan,create_plan_with_http_info") + # Authentication setting auth_settings = [] @@ -288,7 +293,8 @@ def create_plan_with_http_info(self, create_plan_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def deactivate_plan(self, id, **kwargs): """ @@ -395,6 +401,8 @@ def deactivate_plan_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "deactivate_plan,deactivate_plan_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "deactivate_plan,deactivate_plan_with_http_info") + # Authentication setting auth_settings = [] @@ -411,7 +419,8 @@ def deactivate_plan_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def delete_plan(self, id, **kwargs): """ @@ -518,6 +527,8 @@ def delete_plan_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_plan,delete_plan_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_plan,delete_plan_with_http_info") + # Authentication setting auth_settings = [] @@ -534,7 +545,8 @@ def delete_plan_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_plan(self, id, **kwargs): """ @@ -641,6 +653,8 @@ def get_plan_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_plan,get_plan_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_plan,get_plan_with_http_info") + # Authentication setting auth_settings = [] @@ -657,7 +671,8 @@ def get_plan_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_plan_code(self, **kwargs): """ @@ -753,6 +768,8 @@ def get_plan_code_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_plan_code,get_plan_code_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_plan_code,get_plan_code_with_http_info") + # Authentication setting auth_settings = [] @@ -769,7 +786,8 @@ def get_plan_code_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_plans(self, **kwargs): """ @@ -886,6 +904,8 @@ def get_plans_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_plans,get_plans_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_plans,get_plans_with_http_info") + # Authentication setting auth_settings = [] @@ -902,7 +922,8 @@ def get_plans_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def update_plan(self, id, update_plan_request, **kwargs): """ @@ -1015,6 +1036,8 @@ def update_plan_with_http_info(self, id, update_plan_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "update_plan,update_plan_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "update_plan,update_plan_with_http_info") + # Authentication setting auth_settings = [] @@ -1031,4 +1054,5 @@ def update_plan_with_http_info(self, id, update_plan_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/purchase_and_refund_details_api.py b/CyberSource/api/purchase_and_refund_details_api.py index e1f7615a..14b5ef03 100644 --- a/CyberSource/api/purchase_and_refund_details_api.py +++ b/CyberSource/api/purchase_and_refund_details_api.py @@ -185,6 +185,8 @@ def get_purchase_and_refund_details_with_http_info(self, start_time, end_time, * if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_purchase_and_refund_details,get_purchase_and_refund_details_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_purchase_and_refund_details,get_purchase_and_refund_details_with_http_info") + # Authentication setting auth_settings = [] @@ -201,4 +203,5 @@ def get_purchase_and_refund_details_with_http_info(self, start_time, end_time, * _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/push_funds_api.py b/CyberSource/api/push_funds_api.py index 745945a1..061ebed1 100644 --- a/CyberSource/api/push_funds_api.py +++ b/CyberSource/api/push_funds_api.py @@ -203,6 +203,8 @@ def create_push_funds_transfer_with_http_info(self, push_funds_request, content_ if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_push_funds_transfer,create_push_funds_transfer_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_push_funds_transfer,create_push_funds_transfer_with_http_info") + # Authentication setting auth_settings = [] @@ -219,4 +221,5 @@ def create_push_funds_transfer_with_http_info(self, push_funds_request, content_ _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/refund_api.py b/CyberSource/api/refund_api.py index b1c14f9d..96f4f803 100644 --- a/CyberSource/api/refund_api.py +++ b/CyberSource/api/refund_api.py @@ -159,6 +159,8 @@ def refund_capture_with_http_info(self, refund_capture_request, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "refund_capture,refund_capture_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "refund_capture,refund_capture_with_http_info") + # Authentication setting auth_settings = [] @@ -175,7 +177,8 @@ def refund_capture_with_http_info(self, refund_capture_request, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def refund_payment(self, refund_payment_request, id, **kwargs): """ @@ -288,6 +291,8 @@ def refund_payment_with_http_info(self, refund_payment_request, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "refund_payment,refund_payment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "refund_payment,refund_payment_with_http_info") + # Authentication setting auth_settings = [] @@ -304,4 +309,5 @@ def refund_payment_with_http_info(self, refund_payment_request, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/report_definitions_api.py b/CyberSource/api/report_definitions_api.py index bc28bf5c..f5799e66 100644 --- a/CyberSource/api/report_definitions_api.py +++ b/CyberSource/api/report_definitions_api.py @@ -165,6 +165,8 @@ def get_resource_info_by_report_definition_with_http_info(self, report_definitio if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_resource_info_by_report_definition,get_resource_info_by_report_definition_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_resource_info_by_report_definition,get_resource_info_by_report_definition_with_http_info") + # Authentication setting auth_settings = [] @@ -181,7 +183,8 @@ def get_resource_info_by_report_definition_with_http_info(self, report_definitio _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_resource_v2_info(self, **kwargs): """ @@ -286,6 +289,8 @@ def get_resource_v2_info_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_resource_v2_info,get_resource_v2_info_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_resource_v2_info,get_resource_v2_info_with_http_info") + # Authentication setting auth_settings = [] @@ -302,4 +307,5 @@ def get_resource_v2_info_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/report_downloads_api.py b/CyberSource/api/report_downloads_api.py index da3e216d..e04548cd 100644 --- a/CyberSource/api/report_downloads_api.py +++ b/CyberSource/api/report_downloads_api.py @@ -165,6 +165,8 @@ def download_report_with_http_info(self, report_date, report_name, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "download_report,download_report_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "download_report,download_report_with_http_info") + # Authentication setting auth_settings = [] @@ -181,4 +183,5 @@ def download_report_with_http_info(self, report_date, report_name, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/report_subscriptions_api.py b/CyberSource/api/report_subscriptions_api.py index 9ab27e48..819e4126 100644 --- a/CyberSource/api/report_subscriptions_api.py +++ b/CyberSource/api/report_subscriptions_api.py @@ -153,6 +153,8 @@ def create_standard_or_classic_subscription_with_http_info(self, predefined_subs if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_standard_or_classic_subscription,create_standard_or_classic_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_standard_or_classic_subscription,create_standard_or_classic_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -169,7 +171,8 @@ def create_standard_or_classic_subscription_with_http_info(self, predefined_subs _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def create_subscription(self, create_report_subscription_request, **kwargs): """ @@ -276,6 +279,8 @@ def create_subscription_with_http_info(self, create_report_subscription_request, if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_subscription,create_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_subscription,create_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -292,7 +297,8 @@ def create_subscription_with_http_info(self, create_report_subscription_request, _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def delete_subscription(self, report_name, **kwargs): """ @@ -403,6 +409,8 @@ def delete_subscription_with_http_info(self, report_name, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_subscription,delete_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_subscription,delete_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -419,7 +427,8 @@ def delete_subscription_with_http_info(self, report_name, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_all_subscriptions(self, **kwargs): """ @@ -520,6 +529,8 @@ def get_all_subscriptions_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_all_subscriptions,get_all_subscriptions_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_all_subscriptions,get_all_subscriptions_with_http_info") + # Authentication setting auth_settings = [] @@ -536,7 +547,8 @@ def get_all_subscriptions_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_subscription(self, report_name, **kwargs): """ @@ -647,6 +659,8 @@ def get_subscription_with_http_info(self, report_name, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_subscription,get_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_subscription,get_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -663,4 +677,5 @@ def get_subscription_with_http_info(self, report_name, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/reports_api.py b/CyberSource/api/reports_api.py index 5b3de1ef..a0d6fe19 100644 --- a/CyberSource/api/reports_api.py +++ b/CyberSource/api/reports_api.py @@ -153,6 +153,8 @@ def create_report_with_http_info(self, create_adhoc_report_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_report,create_report_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_report,create_report_with_http_info") + # Authentication setting auth_settings = [] @@ -169,7 +171,8 @@ def create_report_with_http_info(self, create_adhoc_report_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_report_by_report_id(self, report_id, **kwargs): """ @@ -280,6 +283,8 @@ def get_report_by_report_id_with_http_info(self, report_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_report_by_report_id,get_report_by_report_id_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_report_by_report_id,get_report_by_report_id_with_http_info") + # Authentication setting auth_settings = [] @@ -296,7 +301,8 @@ def get_report_by_report_id_with_http_info(self, report_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def search_reports(self, start_time, end_time, time_query_type, **kwargs): """ @@ -444,6 +450,8 @@ def search_reports_with_http_info(self, start_time, end_time, time_query_type, * if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "search_reports,search_reports_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "search_reports,search_reports_with_http_info") + # Authentication setting auth_settings = [] @@ -460,4 +468,5 @@ def search_reports_with_http_info(self, start_time, end_time, time_query_type, * _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/retrieval_details_api.py b/CyberSource/api/retrieval_details_api.py index 45a88a3b..30908bec 100644 --- a/CyberSource/api/retrieval_details_api.py +++ b/CyberSource/api/retrieval_details_api.py @@ -165,6 +165,8 @@ def get_retrieval_details_with_http_info(self, start_time, end_time, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_retrieval_details,get_retrieval_details_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_retrieval_details,get_retrieval_details_with_http_info") + # Authentication setting auth_settings = [] @@ -181,4 +183,5 @@ def get_retrieval_details_with_http_info(self, start_time, end_time, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/retrieval_summaries_api.py b/CyberSource/api/retrieval_summaries_api.py index d74c864f..4b657034 100644 --- a/CyberSource/api/retrieval_summaries_api.py +++ b/CyberSource/api/retrieval_summaries_api.py @@ -165,6 +165,8 @@ def get_retrieval_summary_with_http_info(self, start_time, end_time, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_retrieval_summary,get_retrieval_summary_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_retrieval_summary,get_retrieval_summary_with_http_info") + # Authentication setting auth_settings = [] @@ -181,4 +183,5 @@ def get_retrieval_summary_with_http_info(self, start_time, end_time, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/reversal_api.py b/CyberSource/api/reversal_api.py index 33340bba..11475d6d 100644 --- a/CyberSource/api/reversal_api.py +++ b/CyberSource/api/reversal_api.py @@ -159,6 +159,8 @@ def auth_reversal_with_http_info(self, id, auth_reversal_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "auth_reversal,auth_reversal_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "auth_reversal,auth_reversal_with_http_info") + # Authentication setting auth_settings = [] @@ -175,7 +177,8 @@ def auth_reversal_with_http_info(self, id, auth_reversal_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def mit_reversal(self, mit_reversal_request, **kwargs): """ @@ -278,6 +281,8 @@ def mit_reversal_with_http_info(self, mit_reversal_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "mit_reversal,mit_reversal_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "mit_reversal,mit_reversal_with_http_info") + # Authentication setting auth_settings = [] @@ -294,4 +299,5 @@ def mit_reversal_with_http_info(self, mit_reversal_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/search_transactions_api.py b/CyberSource/api/search_transactions_api.py index 86245ea6..d0bd6a9a 100644 --- a/CyberSource/api/search_transactions_api.py +++ b/CyberSource/api/search_transactions_api.py @@ -149,6 +149,8 @@ def create_search_with_http_info(self, create_search_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_search,create_search_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_search,create_search_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def create_search_with_http_info(self, create_search_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_search(self, search_id, **kwargs): """ @@ -272,6 +275,8 @@ def get_search_with_http_info(self, search_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_search,get_search_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_search,get_search_with_http_info") + # Authentication setting auth_settings = [] @@ -288,4 +293,5 @@ def get_search_with_http_info(self, search_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/secure_file_share_api.py b/CyberSource/api/secure_file_share_api.py index b52f319d..5f3a8dad 100644 --- a/CyberSource/api/secure_file_share_api.py +++ b/CyberSource/api/secure_file_share_api.py @@ -157,6 +157,8 @@ def get_file_with_http_info(self, file_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_file,get_file_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_file,get_file_with_http_info") + # Authentication setting auth_settings = [] @@ -173,7 +175,8 @@ def get_file_with_http_info(self, file_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_file_detail(self, start_date, end_date, **kwargs): """ @@ -296,6 +299,8 @@ def get_file_detail_with_http_info(self, start_date, end_date, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_file_detail,get_file_detail_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_file_detail,get_file_detail_with_http_info") + # Authentication setting auth_settings = [] @@ -312,4 +317,5 @@ def get_file_detail_with_http_info(self, start_date, end_date, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/subscriptions_api.py b/CyberSource/api/subscriptions_api.py index 3968915e..2a4ea5d1 100644 --- a/CyberSource/api/subscriptions_api.py +++ b/CyberSource/api/subscriptions_api.py @@ -157,6 +157,8 @@ def activate_subscription_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "activate_subscription,activate_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "activate_subscription,activate_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -173,7 +175,8 @@ def activate_subscription_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def cancel_subscription(self, id, **kwargs): """ @@ -280,6 +283,8 @@ def cancel_subscription_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "cancel_subscription,cancel_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "cancel_subscription,cancel_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -296,7 +301,8 @@ def cancel_subscription_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def create_subscription(self, create_subscription_request, **kwargs): """ @@ -399,6 +405,8 @@ def create_subscription_with_http_info(self, create_subscription_request, **kwar if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_subscription,create_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_subscription,create_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -415,7 +423,8 @@ def create_subscription_with_http_info(self, create_subscription_request, **kwar _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_all_subscriptions(self, **kwargs): """ @@ -528,6 +537,8 @@ def get_all_subscriptions_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_all_subscriptions,get_all_subscriptions_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_all_subscriptions,get_all_subscriptions_with_http_info") + # Authentication setting auth_settings = [] @@ -544,7 +555,8 @@ def get_all_subscriptions_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_subscription(self, id, **kwargs): """ @@ -651,6 +663,8 @@ def get_subscription_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_subscription,get_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_subscription,get_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -667,7 +681,8 @@ def get_subscription_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_subscription_code(self, **kwargs): """ @@ -763,6 +778,8 @@ def get_subscription_code_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_subscription_code,get_subscription_code_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_subscription_code,get_subscription_code_with_http_info") + # Authentication setting auth_settings = [] @@ -779,7 +796,8 @@ def get_subscription_code_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def suspend_subscription(self, id, **kwargs): """ @@ -886,6 +904,8 @@ def suspend_subscription_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "suspend_subscription,suspend_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "suspend_subscription,suspend_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -902,7 +922,8 @@ def suspend_subscription_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def update_subscription(self, id, update_subscription, **kwargs): """ @@ -1015,6 +1036,8 @@ def update_subscription_with_http_info(self, id, update_subscription, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "update_subscription,update_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "update_subscription,update_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -1031,4 +1054,5 @@ def update_subscription_with_http_info(self, id, update_subscription, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/subscriptions_follow_ons_api.py b/CyberSource/api/subscriptions_follow_ons_api.py index 0a44ec24..4e094066 100644 --- a/CyberSource/api/subscriptions_follow_ons_api.py +++ b/CyberSource/api/subscriptions_follow_ons_api.py @@ -159,6 +159,8 @@ def create_follow_on_subscription_with_http_info(self, request_id, create_subscr if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "create_follow_on_subscription,create_follow_on_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "create_follow_on_subscription,create_follow_on_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -175,7 +177,8 @@ def create_follow_on_subscription_with_http_info(self, request_id, create_subscr _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_follow_on_subscription(self, request_id, **kwargs): """ @@ -282,6 +285,8 @@ def get_follow_on_subscription_with_http_info(self, request_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_follow_on_subscription,get_follow_on_subscription_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_follow_on_subscription,get_follow_on_subscription_with_http_info") + # Authentication setting auth_settings = [] @@ -298,4 +303,5 @@ def get_follow_on_subscription_with_http_info(self, request_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/taxes_api.py b/CyberSource/api/taxes_api.py index 439e649f..d153ea3a 100644 --- a/CyberSource/api/taxes_api.py +++ b/CyberSource/api/taxes_api.py @@ -149,6 +149,8 @@ def calculate_tax_with_http_info(self, tax_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "calculate_tax,calculate_tax_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "calculate_tax,calculate_tax_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def calculate_tax_with_http_info(self, tax_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def void_tax(self, void_tax_request, id, **kwargs): """ @@ -278,6 +281,8 @@ def void_tax_with_http_info(self, void_tax_request, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "void_tax,void_tax_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "void_tax,void_tax_with_http_info") + # Authentication setting auth_settings = [] @@ -294,4 +299,5 @@ def void_tax_with_http_info(self, void_tax_request, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/token_api.py b/CyberSource/api/token_api.py index 6c488afb..22203dd7 100644 --- a/CyberSource/api/token_api.py +++ b/CyberSource/api/token_api.py @@ -173,6 +173,8 @@ def get_card_art_asset_with_http_info(self, instrument_identifier_id, token_prov if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_card_art_asset,get_card_art_asset_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_card_art_asset,get_card_art_asset_with_http_info") + # Authentication setting auth_settings = [] @@ -189,7 +191,8 @@ def get_card_art_asset_with_http_info(self, instrument_identifier_id, token_prov _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_token_payment_credentials(self, token_id, post_payment_credentials_request, **kwargs): """ @@ -306,6 +309,8 @@ def post_token_payment_credentials_with_http_info(self, token_id, post_payment_c if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_token_payment_credentials,post_token_payment_credentials_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_token_payment_credentials,post_token_payment_credentials_with_http_info") + # Authentication setting auth_settings = [] @@ -322,4 +327,5 @@ def post_token_payment_credentials_with_http_info(self, token_id, post_payment_c _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/tokenized_card_api.py b/CyberSource/api/tokenized_card_api.py index c6c0ffa1..89d09ea8 100644 --- a/CyberSource/api/tokenized_card_api.py +++ b/CyberSource/api/tokenized_card_api.py @@ -157,6 +157,8 @@ def delete_tokenized_card_with_http_info(self, tokenized_card_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "delete_tokenized_card,delete_tokenized_card_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "delete_tokenized_card,delete_tokenized_card_with_http_info") + # Authentication setting auth_settings = [] @@ -173,7 +175,8 @@ def delete_tokenized_card_with_http_info(self, tokenized_card_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_tokenized_card(self, tokenized_card_id, **kwargs): """ @@ -284,6 +287,8 @@ def get_tokenized_card_with_http_info(self, tokenized_card_id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_tokenized_card,get_tokenized_card_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_tokenized_card,get_tokenized_card_with_http_info") + # Authentication setting auth_settings = [] @@ -300,7 +305,8 @@ def get_tokenized_card_with_http_info(self, tokenized_card_id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def post_tokenized_card(self, tokenizedcard_request, **kwargs): """ @@ -407,6 +413,8 @@ def post_tokenized_card_with_http_info(self, tokenizedcard_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "post_tokenized_card,post_tokenized_card_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "post_tokenized_card,post_tokenized_card_with_http_info") + # Authentication setting auth_settings = [] @@ -423,4 +431,5 @@ def post_tokenized_card_with_http_info(self, tokenizedcard_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/transaction_batches_api.py b/CyberSource/api/transaction_batches_api.py index 90939d2e..51533aeb 100644 --- a/CyberSource/api/transaction_batches_api.py +++ b/CyberSource/api/transaction_batches_api.py @@ -161,6 +161,8 @@ def get_transaction_batch_details_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_transaction_batch_details,get_transaction_batch_details_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_transaction_batch_details,get_transaction_batch_details_with_http_info") + # Authentication setting auth_settings = [] @@ -177,7 +179,8 @@ def get_transaction_batch_details_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_transaction_batch_id(self, id, **kwargs): """ @@ -284,6 +287,8 @@ def get_transaction_batch_id_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_transaction_batch_id,get_transaction_batch_id_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_transaction_batch_id,get_transaction_batch_id_with_http_info") + # Authentication setting auth_settings = [] @@ -300,7 +305,8 @@ def get_transaction_batch_id_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_transaction_batches(self, start_time, end_time, **kwargs): """ @@ -415,6 +421,8 @@ def get_transaction_batches_with_http_info(self, start_time, end_time, **kwargs) if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_transaction_batches,get_transaction_batches_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_transaction_batches,get_transaction_batches_with_http_info") + # Authentication setting auth_settings = [] @@ -431,7 +439,8 @@ def get_transaction_batches_with_http_info(self, start_time, end_time, **kwargs) _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def upload_transaction_batch(self, file, **kwargs): """ @@ -537,6 +546,8 @@ def upload_transaction_batch_with_http_info(self, file, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "upload_transaction_batch,upload_transaction_batch_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "upload_transaction_batch,upload_transaction_batch_with_http_info") + # Authentication setting auth_settings = [] @@ -553,4 +564,5 @@ def upload_transaction_batch_with_http_info(self, file, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/transaction_details_api.py b/CyberSource/api/transaction_details_api.py index 0d23742b..ad2e1bf7 100644 --- a/CyberSource/api/transaction_details_api.py +++ b/CyberSource/api/transaction_details_api.py @@ -153,6 +153,8 @@ def get_transaction_with_http_info(self, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_transaction,get_transaction_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_transaction,get_transaction_with_http_info") + # Authentication setting auth_settings = [] @@ -169,4 +171,5 @@ def get_transaction_with_http_info(self, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/transient_token_data_api.py b/CyberSource/api/transient_token_data_api.py index a612defa..31f40316 100644 --- a/CyberSource/api/transient_token_data_api.py +++ b/CyberSource/api/transient_token_data_api.py @@ -153,6 +153,8 @@ def get_payment_credentials_for_transient_token_with_http_info(self, payment_cre if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_payment_credentials_for_transient_token,get_payment_credentials_for_transient_token_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_payment_credentials_for_transient_token,get_payment_credentials_for_transient_token_with_http_info") + # Authentication setting auth_settings = [] @@ -169,7 +171,8 @@ def get_payment_credentials_for_transient_token_with_http_info(self, payment_cre _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def get_transaction_for_transient_token(self, transient_token, **kwargs): """ @@ -276,6 +279,8 @@ def get_transaction_for_transient_token_with_http_info(self, transient_token, ** if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_transaction_for_transient_token,get_transaction_for_transient_token_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_transaction_for_transient_token,get_transaction_for_transient_token_with_http_info") + # Authentication setting auth_settings = [] @@ -292,4 +297,5 @@ def get_transaction_for_transient_token_with_http_info(self, transient_token, ** _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/unified_checkout_capture_context_api.py b/CyberSource/api/unified_checkout_capture_context_api.py index 6d9c733c..8c4bd361 100644 --- a/CyberSource/api/unified_checkout_capture_context_api.py +++ b/CyberSource/api/unified_checkout_capture_context_api.py @@ -149,6 +149,8 @@ def generate_unified_checkout_capture_context_with_http_info(self, generate_unif if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "generate_unified_checkout_capture_context,generate_unified_checkout_capture_context_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "generate_unified_checkout_capture_context,generate_unified_checkout_capture_context_with_http_info") + # Authentication setting auth_settings = [] @@ -165,4 +167,5 @@ def generate_unified_checkout_capture_context_with_http_info(self, generate_unif _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/user_management_api.py b/CyberSource/api/user_management_api.py index 481b4d82..e7639eb2 100644 --- a/CyberSource/api/user_management_api.py +++ b/CyberSource/api/user_management_api.py @@ -159,6 +159,8 @@ def get_users_with_http_info(self, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "get_users,get_users_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "get_users,get_users_with_http_info") + # Authentication setting auth_settings = [] @@ -175,4 +177,5 @@ def get_users_with_http_info(self, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/user_management_search_api.py b/CyberSource/api/user_management_search_api.py index 1f5ca7f2..989df409 100644 --- a/CyberSource/api/user_management_search_api.py +++ b/CyberSource/api/user_management_search_api.py @@ -149,6 +149,8 @@ def search_users_with_http_info(self, search_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "search_users,search_users_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "search_users,search_users_with_http_info") + # Authentication setting auth_settings = [] @@ -165,4 +167,5 @@ def search_users_with_http_info(self, search_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/verification_api.py b/CyberSource/api/verification_api.py index 78dbf70c..27dd21f3 100644 --- a/CyberSource/api/verification_api.py +++ b/CyberSource/api/verification_api.py @@ -149,6 +149,8 @@ def validate_export_compliance_with_http_info(self, validate_export_compliance_r if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "validate_export_compliance,validate_export_compliance_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "validate_export_compliance,validate_export_compliance_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def validate_export_compliance_with_http_info(self, validate_export_compliance_r _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def verify_customer_address(self, verify_customer_address_request, **kwargs): """ @@ -268,6 +271,8 @@ def verify_customer_address_with_http_info(self, verify_customer_address_request if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "verify_customer_address,verify_customer_address_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "verify_customer_address,verify_customer_address_with_http_info") + # Authentication setting auth_settings = [] @@ -284,4 +289,5 @@ def verify_customer_address_with_http_info(self, verify_customer_address_request _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api/void_api.py b/CyberSource/api/void_api.py index 10b16bd3..d160e51f 100644 --- a/CyberSource/api/void_api.py +++ b/CyberSource/api/void_api.py @@ -149,6 +149,8 @@ def mit_void_with_http_info(self, mit_void_request, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "mit_void,mit_void_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "mit_void,mit_void_with_http_info") + # Authentication setting auth_settings = [] @@ -165,7 +167,8 @@ def mit_void_with_http_info(self, mit_void_request, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def void_capture(self, void_capture_request, id, **kwargs): """ @@ -278,6 +281,8 @@ def void_capture_with_http_info(self, void_capture_request, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "void_capture,void_capture_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "void_capture,void_capture_with_http_info") + # Authentication setting auth_settings = [] @@ -294,7 +299,8 @@ def void_capture_with_http_info(self, void_capture_request, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def void_credit(self, void_credit_request, id, **kwargs): """ @@ -407,6 +413,8 @@ def void_credit_with_http_info(self, void_credit_request, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "void_credit,void_credit_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "void_credit,void_credit_with_http_info") + # Authentication setting auth_settings = [] @@ -423,7 +431,8 @@ def void_credit_with_http_info(self, void_credit_request, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def void_payment(self, void_payment_request, id, **kwargs): """ @@ -536,6 +545,8 @@ def void_payment_with_http_info(self, void_payment_request, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "void_payment,void_payment_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "void_payment,void_payment_with_http_info") + # Authentication setting auth_settings = [] @@ -552,7 +563,8 @@ def void_payment_with_http_info(self, void_payment_request, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) def void_refund(self, void_refund_request, id, **kwargs): """ @@ -665,6 +677,8 @@ def void_refund_with_http_info(self, void_refund_request, id, **kwargs): if MLEUtility.check_is_mle_for_api(self.api_client.mconfig, inbound_mle_status, "void_refund,void_refund_with_http_info"): body_params = MLEUtility.encrypt_request_payload(self.api_client.mconfig, body_params) + isResponseMLEforApi = MLEUtility.check_is_response_mle_for_api(self.api_client.mconfig, "void_refund,void_refund_with_http_info") + # Authentication setting auth_settings = [] @@ -681,4 +695,5 @@ def void_refund_with_http_info(self, void_refund_request, id, **kwargs): _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + collection_formats=collection_formats, + isResponseMLEforApi=isResponseMLEforApi) diff --git a/CyberSource/api_client.py b/CyberSource/api_client.py index c03bf28d..a326f74f 100644 --- a/CyberSource/api_client.py +++ b/CyberSource/api_client.py @@ -17,8 +17,6 @@ import tempfile import threading import pkg_resources -import logging -import CyberSource.logging.log_factory as LogFactory from datetime import date, datetime @@ -34,8 +32,9 @@ from authenticationsdk.util.PropertiesUtil import * from authenticationsdk.util.GlobalLabelParameters import * from authenticationsdk.util.MLEUtility import MLEUtility - from six.moves.urllib.parse import urlencode +import logging +import CyberSource.logging.log_factory as LogFactory class ApiClient(object): @@ -156,6 +155,7 @@ def set_configuration(self,config): # To reinitialize with logging config self.rest_client = RESTClientObject(log_config=self.mconfig.log_config) + try: self.logger = LogFactory.setup_logger(self.__class__.__name__, self.mconfig.log_config) except Exception: @@ -317,21 +317,19 @@ def __call_api(self, resource_path, method, post_params=post_params, body=body, _preload_content=_preload_content, _request_timeout=_request_timeout) - + if hasattr(self, 'mconfig'): - try: - if MLEUtility.check_is_mle_encrypted_response(response_data.data): - decrypted_data = MLEUtility.decrypt_mle_response_payload(self.mconfig, response_data.data) - response_data.data = decrypted_data - except Exception as e: - # Log the error but continue with the response - if (hasattr(self, "logger") and - hasattr(self.mconfig, "log_config") and - self.mconfig.log_config.enable_log): - self.logger.error("[MLE] Failed to decrypt response.") + try: + if MLEUtility.check_is_mle_encrypted_response(response_data.data): + decrypted_data = MLEUtility.decrypt_mle_response_payload(self.mconfig, response_data.data) + response_data.data = decrypted_data + except Exception as e: + if (hasattr(self, "logger") and + hasattr(self.mconfig, "log_config") and + self.mconfig.log_config.enable_log): + self.logger.error("[MLE] Failed to decrypt response") raise ApiException(status=500, reason=f"MLE response decryption failed: {e}") - if self.download_file_path is None: self.last_response = response_data @@ -482,7 +480,6 @@ def call_api(self, resource_path, method, query_param_path = self.set_query_params(resource_path, query_params) request_target = query_param_path if query_param_path else resource_path - if self.mconfig.authentication_type.upper() != GlobalLabelParameters.MUTUAL_AUTH.upper(): self.call_authentication_header(method, header_params, body, request_target, isResponseMLEforApi=isResponseMLEforApi) @@ -525,7 +522,8 @@ def call_api(self, resource_path, method, path_params, query_params, header_params, body, post_params, files, response_type, auth_settings, callback, - _return_http_data_only, collection_formats, _preload_content, _request_timeout, isResponseMLEforApi=isResponseMLEforApi) + _return_http_data_only, collection_formats, _preload_content, _request_timeout, + isResponseMLEforApi=isResponseMLEforApi) else: thread = threading.Thread(target=self.__call_api, args=(resource_path, method, diff --git a/docs/PushFunds401Response.md b/docs/PushFunds401Response.md new file mode 100644 index 00000000..48f43d9b --- /dev/null +++ b/docs/PushFunds401Response.md @@ -0,0 +1,13 @@ +# PushFunds401Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identification number to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submit_time_utc** | **str** | 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] +**reason** | **str** | The reason of the status. Possible values: - UNAUTHORIZED | [optional] +**message** | **str** | The detail message related to the status and reason listed above. Possible values: - Authentication Failed | [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/PushFunds404Response.md b/docs/PushFunds404Response.md new file mode 100644 index 00000000..f07d5d85 --- /dev/null +++ b/docs/PushFunds404Response.md @@ -0,0 +1,13 @@ +# PushFunds404Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identification number to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submit_time_utc** | **str** | 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] +**reason** | **str** | The reason of the status. Possible values: - NOT_FOUND | [optional] +**message** | **str** | The detail message related to the status and reason listed above. Possible values: - The requested resource does not exist | [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/PushFunds502Response.md b/docs/PushFunds502Response.md new file mode 100644 index 00000000..c6ab5430 --- /dev/null +++ b/docs/PushFunds502Response.md @@ -0,0 +1,14 @@ +# PushFunds502Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identification number to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submit_time_utc** | **str** | 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** | **str** | Possible values: - SERVER_ERROR | [optional] +**reason** | **str** | The reason of the status. Possible values: - SYSTEM_ERROR - SERVICE_TIMEOUT | [optional] +**message** | **str** | The detail message related to the status and reason listed above. Possible values: - Error - General system failure. - The request was received, but a service did not finish running in time. | [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/PushFundsApi.md b/docs/PushFundsApi.md new file mode 100644 index 00000000..ebf4f3d2 --- /dev/null +++ b/docs/PushFundsApi.md @@ -0,0 +1,69 @@ +# CyberSource.PushFundsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_push_funds_transfer**](PushFundsApi.md#create_push_funds_transfer) | **POST** /pts/v1/push-funds-transfer | Process a Push Funds Transfer + + +# **create_push_funds_transfer** +> PushFunds201Response create_push_funds_transfer(push_funds_request, content_type, x_requestid, v_c_merchant_id, v_c_permissions, v_c_correlation_id, v_c_organization_id) + +Process a Push Funds Transfer + +Receive funds using an Original Credit Transaction (OCT). + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.PushFundsApi() +push_funds_request = CyberSource.PushFundsRequest() # PushFundsRequest | +content_type = 'content_type_example' # str | +x_requestid = 'x_requestid_example' # str | +v_c_merchant_id = 'v_c_merchant_id_example' # str | +v_c_permissions = 'v_c_permissions_example' # str | +v_c_correlation_id = 'v_c_correlation_id_example' # str | +v_c_organization_id = 'v_c_organization_id_example' # str | + +try: + # Process a Push Funds Transfer + api_response = api_instance.create_push_funds_transfer(push_funds_request, content_type, x_requestid, v_c_merchant_id, v_c_permissions, v_c_correlation_id, v_c_organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PushFundsApi->create_push_funds_transfer: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **push_funds_request** | [**PushFundsRequest**](PushFundsRequest.md)| | + **content_type** | **str**| | + **x_requestid** | **str**| | + **v_c_merchant_id** | **str**| | + **v_c_permissions** | **str**| | + **v_c_correlation_id** | **str**| | + **v_c_organization_id** | **str**| | + +### Return type + +[**PushFunds201Response**](PushFunds201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PushFundsRequest.md b/docs/PushFundsRequest.md new file mode 100644 index 00000000..da473119 --- /dev/null +++ b/docs/PushFundsRequest.md @@ -0,0 +1,17 @@ +# PushFundsRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aggregator_information** | [**Ptsv2payoutsAggregatorInformation**](Ptsv2payoutsAggregatorInformation.md) | | [optional] +**client_reference_information** | [**Ptsv1pushfundstransferClientReferenceInformation**](Ptsv1pushfundstransferClientReferenceInformation.md) | | [optional] +**order_information** | [**Ptsv1pushfundstransferOrderInformation**](Ptsv1pushfundstransferOrderInformation.md) | | +**processing_information** | [**Ptsv1pushfundstransferProcessingInformation**](Ptsv1pushfundstransferProcessingInformation.md) | | [optional] +**recipient_information** | [**Ptsv1pushfundstransferRecipientInformation**](Ptsv1pushfundstransferRecipientInformation.md) | | [optional] +**sender_information** | [**Ptsv1pushfundstransferSenderInformation**](Ptsv1pushfundstransferSenderInformation.md) | | [optional] +**merchant_information** | [**Ptsv1pushfundstransferMerchantInformation**](Ptsv1pushfundstransferMerchantInformation.md) | | [optional] +**point_of_service_information** | [**Ptsv1pushfundstransferPointOfServiceInformation**](Ptsv1pushfundstransferPointOfServiceInformation.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/Rbsv1plansClientReferenceInformation.md b/docs/Rbsv1plansClientReferenceInformation.md new file mode 100644 index 00000000..0efc8bda --- /dev/null +++ b/docs/Rbsv1plansClientReferenceInformation.md @@ -0,0 +1,14 @@ +# Rbsv1plansClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] +**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] +**application_name** | **str** | 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] +**application_version** | **str** | Version of the CyberSource application or integration used for a transaction. | [optional] +**application_user** | **str** | 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. | [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/Rbsv1plansOrderInformation.md b/docs/Rbsv1plansOrderInformation.md new file mode 100644 index 00000000..fbb40798 --- /dev/null +++ b/docs/Rbsv1plansOrderInformation.md @@ -0,0 +1,10 @@ +# Rbsv1plansOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_details** | [**Rbsv1plansOrderInformationAmountDetails**](Rbsv1plansOrderInformationAmountDetails.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/Rbsv1plansOrderInformationAmountDetails.md b/docs/Rbsv1plansOrderInformationAmountDetails.md new file mode 100644 index 00000000..fc163ba2 --- /dev/null +++ b/docs/Rbsv1plansOrderInformationAmountDetails.md @@ -0,0 +1,12 @@ +# Rbsv1plansOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **str** | 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. | +**billing_amount** | **str** | Billing amount for the billing period. | +**setup_fee** | **str** | Subscription setup fee | [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/Rbsv1plansPlanInformation.md b/docs/Rbsv1plansPlanInformation.md new file mode 100644 index 00000000..10a55ede --- /dev/null +++ b/docs/Rbsv1plansPlanInformation.md @@ -0,0 +1,15 @@ +# Rbsv1plansPlanInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Plan code is an optional field, If not provided system generates and assign one | [optional] +**name** | **str** | Plan name | +**description** | **str** | Plan description | [optional] +**status** | **str** | Plan Status: - `DRAFT` - `ACTIVE` (default) | [optional] +**billing_period** | [**GetAllPlansResponsePlanInformationBillingPeriod**](GetAllPlansResponsePlanInformationBillingPeriod.md) | | +**billing_cycles** | [**Rbsv1plansPlanInformationBillingCycles**](Rbsv1plansPlanInformationBillingCycles.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/Rbsv1plansPlanInformationBillingCycles.md b/docs/Rbsv1plansPlanInformationBillingCycles.md new file mode 100644 index 00000000..abd9857b --- /dev/null +++ b/docs/Rbsv1plansPlanInformationBillingCycles.md @@ -0,0 +1,10 @@ +# Rbsv1plansPlanInformationBillingCycles + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **str** | Describe total number of billing cycles | [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/Rbsv1plansidPlanInformation.md b/docs/Rbsv1plansidPlanInformation.md new file mode 100644 index 00000000..3b2330f7 --- /dev/null +++ b/docs/Rbsv1plansidPlanInformation.md @@ -0,0 +1,15 @@ +# Rbsv1plansidPlanInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Plan code is an optional field, If not provided system generates and assign one | [optional] +**name** | **str** | Plan name | [optional] +**description** | **str** | Plan description | [optional] +**status** | **str** | Updating to `DRAFT` is not allowed from `ACTIVE` and `INACTIVE` status. Plan Status: - `DRAFT` - `ACTIVE` - `INACTIVE` | [optional] +**billing_period** | [**GetAllPlansResponsePlanInformationBillingPeriod**](GetAllPlansResponsePlanInformationBillingPeriod.md) | | [optional] +**billing_cycles** | [**Rbsv1plansPlanInformationBillingCycles**](Rbsv1plansPlanInformationBillingCycles.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/Rbsv1plansidProcessingInformation.md b/docs/Rbsv1plansidProcessingInformation.md new file mode 100644 index 00000000..b14de9f8 --- /dev/null +++ b/docs/Rbsv1plansidProcessingInformation.md @@ -0,0 +1,10 @@ +# Rbsv1plansidProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscription_billing_options** | [**Rbsv1plansidProcessingInformationSubscriptionBillingOptions**](Rbsv1plansidProcessingInformationSubscriptionBillingOptions.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/Rbsv1plansidProcessingInformationSubscriptionBillingOptions.md b/docs/Rbsv1plansidProcessingInformationSubscriptionBillingOptions.md new file mode 100644 index 00000000..a01e44e1 --- /dev/null +++ b/docs/Rbsv1plansidProcessingInformationSubscriptionBillingOptions.md @@ -0,0 +1,10 @@ +# Rbsv1plansidProcessingInformationSubscriptionBillingOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**apply_to** | **str** | Valid Values: - `ALL` - Change applied to all Subscriptions (Existing + New) - `NEW` - Change applied to New Subsciptions 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/Rbsv1subscriptionsClientReferenceInformation.md b/docs/Rbsv1subscriptionsClientReferenceInformation.md new file mode 100644 index 00000000..d2f0b546 --- /dev/null +++ b/docs/Rbsv1subscriptionsClientReferenceInformation.md @@ -0,0 +1,15 @@ +# Rbsv1subscriptionsClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | > Deprecated: This field is ignored. 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** | **str** | > Deprecated: This field is ignored. Brief description of the order or any comment you wish to add to the order. | [optional] +**partner** | [**Rbsv1subscriptionsClientReferenceInformationPartner**](Rbsv1subscriptionsClientReferenceInformationPartner.md) | | [optional] +**application_name** | **str** | > Deprecated: This field is ignored. 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] +**application_version** | **str** | > Deprecated: This field is ignored. Version of the CyberSource application or integration used for a transaction. | [optional] +**application_user** | **str** | > Deprecated: This field is ignored. 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. | [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/Rbsv1subscriptionsClientReferenceInformationPartner.md b/docs/Rbsv1subscriptionsClientReferenceInformationPartner.md new file mode 100644 index 00000000..5c8f2060 --- /dev/null +++ b/docs/Rbsv1subscriptionsClientReferenceInformationPartner.md @@ -0,0 +1,11 @@ +# Rbsv1subscriptionsClientReferenceInformationPartner + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**developer_id** | **str** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. | [optional] +**solution_id** | **str** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [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/Rbsv1subscriptionsPaymentInformation.md b/docs/Rbsv1subscriptionsPaymentInformation.md new file mode 100644 index 00000000..f0f59598 --- /dev/null +++ b/docs/Rbsv1subscriptionsPaymentInformation.md @@ -0,0 +1,10 @@ +# Rbsv1subscriptionsPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer** | [**Rbsv1subscriptionsPaymentInformationCustomer**](Rbsv1subscriptionsPaymentInformationCustomer.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/Rbsv1subscriptionsPaymentInformationCustomer.md b/docs/Rbsv1subscriptionsPaymentInformationCustomer.md new file mode 100644 index 00000000..b9e63d50 --- /dev/null +++ b/docs/Rbsv1subscriptionsPaymentInformationCustomer.md @@ -0,0 +1,10 @@ +# Rbsv1subscriptionsPaymentInformationCustomer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | 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. | + +[[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/Rbsv1subscriptionsPlanInformation.md b/docs/Rbsv1subscriptionsPlanInformation.md new file mode 100644 index 00000000..3d040550 --- /dev/null +++ b/docs/Rbsv1subscriptionsPlanInformation.md @@ -0,0 +1,11 @@ +# Rbsv1subscriptionsPlanInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**billing_period** | [**GetAllPlansResponsePlanInformationBillingPeriod**](GetAllPlansResponsePlanInformationBillingPeriod.md) | | [optional] +**billing_cycles** | [**Rbsv1plansPlanInformationBillingCycles**](Rbsv1plansPlanInformationBillingCycles.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/Rbsv1subscriptionsProcessingInformation.md b/docs/Rbsv1subscriptionsProcessingInformation.md new file mode 100644 index 00000000..1918e7b8 --- /dev/null +++ b/docs/Rbsv1subscriptionsProcessingInformation.md @@ -0,0 +1,11 @@ +# Rbsv1subscriptionsProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commerce_indicator** | **str** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Commerce Indicator is a way to identify the type of transaction. Some payment card companies use this information when determining discount rates. Valid values: - `MOTO` - `RECURRING` - `INTERNET` Please add the ecommerce indicator based on the rules defined by your gateway/processor. Some gateways may not accept the Commerce Indicator `RECURRING` with a Zero Dollar Authorization, that is done for subscriptions starting at a future date. | [optional] +**authorization_options** | [**Rbsv1subscriptionsProcessingInformationAuthorizationOptions**](Rbsv1subscriptionsProcessingInformationAuthorizationOptions.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/Rbsv1subscriptionsProcessingInformationAuthorizationOptions.md b/docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptions.md new file mode 100644 index 00000000..eae8e2e8 --- /dev/null +++ b/docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptions.md @@ -0,0 +1,10 @@ +# Rbsv1subscriptionsProcessingInformationAuthorizationOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**initiator** | [**Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator**](Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.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/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.md b/docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.md new file mode 100644 index 00000000..83598bf2 --- /dev/null +++ b/docs/Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator.md @@ -0,0 +1,10 @@ +# Rbsv1subscriptionsProcessingInformationAuthorizationOptionsInitiator + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** | [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/Rbsv1subscriptionsSubscriptionInformation.md b/docs/Rbsv1subscriptionsSubscriptionInformation.md new file mode 100644 index 00000000..80abfa9d --- /dev/null +++ b/docs/Rbsv1subscriptionsSubscriptionInformation.md @@ -0,0 +1,15 @@ +# Rbsv1subscriptionsSubscriptionInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Subscription code is an optional field, If not provided system generates and assign one | [optional] +**plan_id** | **str** | Plan Id. Use Plan Id from Create Plan Service. | [optional] +**name** | **str** | Subscription Name | +**start_date** | **str** | Start date of the Subscription Start date must be in UTC. Format: YYYY-MM-DDThh:mm:ssZ The T separates the date and the time. The Z indicates UTC. Note: Subscription starts on the day provided in UTC. **Example** 2022-08-11T22:47:57Z equals August 11, 2022, at 22:47:57 (10:47:57 p.m.). Subscription will start on August 11,2022. | +**original_transaction_id** | **str** | Network transaction identifier that was returned in the payment response field _processorInformation.transactionId_ in the reply message for the original subscription-initializing payment. | [optional] +**original_transaction_authorized_amount** | **str** | Amount of the original subscription-initializing payment. *Required when using a Diners or Discover card*. | [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/Rbsv1subscriptionsidOrderInformation.md b/docs/Rbsv1subscriptionsidOrderInformation.md new file mode 100644 index 00000000..6ae69549 --- /dev/null +++ b/docs/Rbsv1subscriptionsidOrderInformation.md @@ -0,0 +1,10 @@ +# Rbsv1subscriptionsidOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_details** | [**Rbsv1subscriptionsidOrderInformationAmountDetails**](Rbsv1subscriptionsidOrderInformationAmountDetails.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/Rbsv1subscriptionsidOrderInformationAmountDetails.md b/docs/Rbsv1subscriptionsidOrderInformationAmountDetails.md new file mode 100644 index 00000000..6c48c11d --- /dev/null +++ b/docs/Rbsv1subscriptionsidOrderInformationAmountDetails.md @@ -0,0 +1,11 @@ +# Rbsv1subscriptionsidOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**billing_amount** | **str** | Billing amount for the billing period. | [optional] +**setup_fee** | **str** | Subscription setup fee | [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/Rbsv1subscriptionsidPlanInformation.md b/docs/Rbsv1subscriptionsidPlanInformation.md new file mode 100644 index 00000000..2aa686ac --- /dev/null +++ b/docs/Rbsv1subscriptionsidPlanInformation.md @@ -0,0 +1,10 @@ +# Rbsv1subscriptionsidPlanInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**billing_cycles** | [**Rbsv1plansPlanInformationBillingCycles**](Rbsv1plansPlanInformationBillingCycles.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/Rbsv1subscriptionsidSubscriptionInformation.md b/docs/Rbsv1subscriptionsidSubscriptionInformation.md new file mode 100644 index 00000000..ec4e878a --- /dev/null +++ b/docs/Rbsv1subscriptionsidSubscriptionInformation.md @@ -0,0 +1,13 @@ +# Rbsv1subscriptionsidSubscriptionInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Subscription code is an optional field, If not provided system generates and assign one | [optional] +**plan_id** | **str** | Plan Id. Use Plan Id from Create Plan Service. | [optional] +**name** | **str** | Subscription Name | [optional] +**start_date** | **str** | Start date of the Subscription Start date must be in UTC. Format: YYYY-MM-DDThh:mm:ssZ The T separates the date and the time. The Z indicates UTC. Note: Subscription starts on the day provided in UTC. **Example** 2022-08-11T22:47:57Z equals August 11, 2022, at 22:47:57 (10:47:57 p.m.). Subscription will start on August 11,2022. | [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/RefreshPaymentStatusRequest.md b/docs/RefreshPaymentStatusRequest.md new file mode 100644 index 00000000..069b839a --- /dev/null +++ b/docs/RefreshPaymentStatusRequest.md @@ -0,0 +1,13 @@ +# RefreshPaymentStatusRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_information** | [**Ptsv2refreshpaymentstatusidPaymentInformation**](Ptsv2refreshpaymentstatusidPaymentInformation.md) | | [optional] +**client_reference_information** | [**Ptsv2refreshpaymentstatusidClientReferenceInformation**](Ptsv2refreshpaymentstatusidClientReferenceInformation.md) | | [optional] +**agreement_information** | [**Ptsv2refreshpaymentstatusidAgreementInformation**](Ptsv2refreshpaymentstatusidAgreementInformation.md) | | [optional] +**processing_information** | [**Ptsv2refreshpaymentstatusidProcessingInformation**](Ptsv2refreshpaymentstatusidProcessingInformation.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/RefundApi.md b/docs/RefundApi.md new file mode 100644 index 00000000..e0305b29 --- /dev/null +++ b/docs/RefundApi.md @@ -0,0 +1,110 @@ +# CyberSource.RefundApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**refund_capture**](RefundApi.md#refund_capture) | **POST** /pts/v2/captures/{id}/refunds | Refund a Capture +[**refund_payment**](RefundApi.md#refund_payment) | **POST** /pts/v2/payments/{id}/refunds | Refund a Payment + + +# **refund_capture** +> PtsV2PaymentsRefundPost201Response refund_capture(refund_capture_request, id) + +Refund a Capture + +Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. Include the capture ID in the POST request to refund the captured amount. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.RefundApi() +refund_capture_request = CyberSource.RefundCaptureRequest() # RefundCaptureRequest | +id = 'id_example' # str | The capture ID. This ID is returned from a previous capture request. + +try: + # Refund a Capture + api_response = api_instance.refund_capture(refund_capture_request, id) + pprint(api_response) +except ApiException as e: + print("Exception when calling RefundApi->refund_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **refund_capture_request** | [**RefundCaptureRequest**](RefundCaptureRequest.md)| | + **id** | **str**| The capture ID. This ID is returned from a previous capture request. | + +### Return type + +[**PtsV2PaymentsRefundPost201Response**](PtsV2PaymentsRefundPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **refund_payment** +> PtsV2PaymentsRefundPost201Response refund_payment(refund_payment_request, id) + +Refund a Payment + +Refund a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to refund the payment amount. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.RefundApi() +refund_payment_request = CyberSource.RefundPaymentRequest() # RefundPaymentRequest | +id = 'id_example' # str | The payment ID. This ID is returned from a previous payment request. + +try: + # Refund a Payment + api_response = api_instance.refund_payment(refund_payment_request, id) + pprint(api_response) +except ApiException as e: + print("Exception when calling RefundApi->refund_payment: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **refund_payment_request** | [**RefundPaymentRequest**](RefundPaymentRequest.md)| | + **id** | **str**| The payment ID. This ID is returned from a previous payment request. | + +### Return type + +[**PtsV2PaymentsRefundPost201Response**](PtsV2PaymentsRefundPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RefundCaptureRequest.md b/docs/RefundCaptureRequest.md new file mode 100644 index 00000000..9fc5bc85 --- /dev/null +++ b/docs/RefundCaptureRequest.md @@ -0,0 +1,21 @@ +# RefundCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Ptsv2paymentsidrefundsClientReferenceInformation**](Ptsv2paymentsidrefundsClientReferenceInformation.md) | | [optional] +**processing_information** | [**Ptsv2paymentsidrefundsProcessingInformation**](Ptsv2paymentsidrefundsProcessingInformation.md) | | [optional] +**payment_information** | [**Ptsv2paymentsidrefundsPaymentInformation**](Ptsv2paymentsidrefundsPaymentInformation.md) | | [optional] +**order_information** | [**Ptsv2paymentsidrefundsOrderInformation**](Ptsv2paymentsidrefundsOrderInformation.md) | | [optional] +**buyer_information** | [**Ptsv2paymentsidcapturesBuyerInformation**](Ptsv2paymentsidcapturesBuyerInformation.md) | | [optional] +**device_information** | [**Ptsv2paymentsidcapturesDeviceInformation**](Ptsv2paymentsidcapturesDeviceInformation.md) | | [optional] +**merchant_information** | [**Ptsv2paymentsidrefundsMerchantInformation**](Ptsv2paymentsidrefundsMerchantInformation.md) | | [optional] +**aggregator_information** | [**Ptsv2paymentsidcapturesAggregatorInformation**](Ptsv2paymentsidcapturesAggregatorInformation.md) | | [optional] +**point_of_sale_information** | [**Ptsv2paymentsidrefundsPointOfSaleInformation**](Ptsv2paymentsidrefundsPointOfSaleInformation.md) | | [optional] +**merchant_defined_information** | [**list[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] +**travel_information** | [**Ptsv2paymentsTravelInformation**](Ptsv2paymentsTravelInformation.md) | | [optional] +**promotion_information** | [**Ptsv2paymentsPromotionInformation**](Ptsv2paymentsPromotionInformation.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/RefundPaymentRequest.md b/docs/RefundPaymentRequest.md new file mode 100644 index 00000000..689efdc3 --- /dev/null +++ b/docs/RefundPaymentRequest.md @@ -0,0 +1,21 @@ +# RefundPaymentRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Ptsv2paymentsidrefundsClientReferenceInformation**](Ptsv2paymentsidrefundsClientReferenceInformation.md) | | [optional] +**processing_information** | [**Ptsv2paymentsidrefundsProcessingInformation**](Ptsv2paymentsidrefundsProcessingInformation.md) | | [optional] +**payment_information** | [**Ptsv2paymentsidrefundsPaymentInformation**](Ptsv2paymentsidrefundsPaymentInformation.md) | | [optional] +**order_information** | [**Ptsv2paymentsidrefundsOrderInformation**](Ptsv2paymentsidrefundsOrderInformation.md) | | [optional] +**buyer_information** | [**Ptsv2paymentsidcapturesBuyerInformation**](Ptsv2paymentsidcapturesBuyerInformation.md) | | [optional] +**device_information** | [**Ptsv2paymentsidcapturesDeviceInformation**](Ptsv2paymentsidcapturesDeviceInformation.md) | | [optional] +**merchant_information** | [**Ptsv2paymentsidrefundsMerchantInformation**](Ptsv2paymentsidrefundsMerchantInformation.md) | | [optional] +**aggregator_information** | [**Ptsv2paymentsidcapturesAggregatorInformation**](Ptsv2paymentsidcapturesAggregatorInformation.md) | | [optional] +**point_of_sale_information** | [**Ptsv2paymentsidrefundsPointOfSaleInformation**](Ptsv2paymentsidrefundsPointOfSaleInformation.md) | | [optional] +**merchant_defined_information** | [**list[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] +**travel_information** | [**Ptsv2paymentsTravelInformation**](Ptsv2paymentsTravelInformation.md) | | [optional] +**promotion_information** | [**Ptsv2paymentsPromotionInformation**](Ptsv2paymentsPromotionInformation.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/ReportDefinitionsApi.md b/docs/ReportDefinitionsApi.md new file mode 100644 index 00000000..26f342b6 --- /dev/null +++ b/docs/ReportDefinitionsApi.md @@ -0,0 +1,114 @@ +# CyberSource.ReportDefinitionsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_resource_info_by_report_definition**](ReportDefinitionsApi.md#get_resource_info_by_report_definition) | **GET** /reporting/v3/report-definitions/{reportDefinitionName} | Get Report Definition +[**get_resource_v2_info**](ReportDefinitionsApi.md#get_resource_v2_info) | **GET** /reporting/v3/report-definitions | Get Reporting Resource Information + + +# **get_resource_info_by_report_definition** +> ReportingV3ReportDefinitionsNameGet200Response get_resource_info_by_report_definition(report_definition_name, subscription_type=subscription_type, report_mime_type=report_mime_type, organization_id=organization_id) + +Get Report Definition + +View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/) + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportDefinitionsApi() +report_definition_name = 'report_definition_name_example' # str | Name of the Report definition to retrieve +subscription_type = 'subscription_type_example' # str | The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD (optional) +report_mime_type = 'report_mime_type_example' # str | The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv (optional) +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Get Report Definition + api_response = api_instance.get_resource_info_by_report_definition(report_definition_name, subscription_type=subscription_type, report_mime_type=report_mime_type, organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling ReportDefinitionsApi->get_resource_info_by_report_definition: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_definition_name** | **str**| Name of the Report definition to retrieve | + **subscription_type** | **str**| The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD | [optional] + **report_mime_type** | **str**| The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv | [optional] + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +[**ReportingV3ReportDefinitionsNameGet200Response**](ReportingV3ReportDefinitionsNameGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_resource_v2_info** +> ReportingV3ReportDefinitionsGet200Response get_resource_v2_info(subscription_type=subscription_type, organization_id=organization_id) + +Get Reporting Resource Information + +View a list of supported reports and their attributes before subscribing to them. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportDefinitionsApi() +subscription_type = 'subscription_type_example' # str | Valid Values: - CLASSIC - CUSTOM - STANDARD (optional) +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Get Reporting Resource Information + api_response = api_instance.get_resource_v2_info(subscription_type=subscription_type, organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling ReportDefinitionsApi->get_resource_v2_info: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_type** | **str**| Valid Values: - CLASSIC - CUSTOM - STANDARD | [optional] + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +[**ReportingV3ReportDefinitionsGet200Response**](ReportingV3ReportDefinitionsGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ReportDownloadsApi.md b/docs/ReportDownloadsApi.md new file mode 100644 index 00000000..d3ad4675 --- /dev/null +++ b/docs/ReportDownloadsApi.md @@ -0,0 +1,60 @@ +# CyberSource.ReportDownloadsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**download_report**](ReportDownloadsApi.md#download_report) | **GET** /reporting/v3/report-downloads | Download a Report + + +# **download_report** +> download_report(report_date, report_name, organization_id=organization_id) + +Download a Report + +Download a report using the unique report name and date. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportDownloadsApi() +report_date = '2013-10-20' # date | Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 +report_name = 'report_name_example' # str | Name of the report to download +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Download a Report + api_instance.download_report(report_date, report_name, organization_id=organization_id) +except ApiException as e: + print("Exception when calling ReportDownloadsApi->download_report: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_date** | **date**| Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10 | + **report_name** | **str**| Name of the report to download | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/xml, text/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ReportSubscriptionsApi.md b/docs/ReportSubscriptionsApi.md new file mode 100644 index 00000000..907b7dc1 --- /dev/null +++ b/docs/ReportSubscriptionsApi.md @@ -0,0 +1,258 @@ +# CyberSource.ReportSubscriptionsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_standard_or_classic_subscription**](ReportSubscriptionsApi.md#create_standard_or_classic_subscription) | **PUT** /reporting/v3/predefined-report-subscriptions | Create a Standard or Classic Subscription +[**create_subscription**](ReportSubscriptionsApi.md#create_subscription) | **PUT** /reporting/v3/report-subscriptions | Create Report Subscription for a Report Name by Organization +[**delete_subscription**](ReportSubscriptionsApi.md#delete_subscription) | **DELETE** /reporting/v3/report-subscriptions/{reportName} | Delete Subscription of a Report Name by Organization +[**get_all_subscriptions**](ReportSubscriptionsApi.md#get_all_subscriptions) | **GET** /reporting/v3/report-subscriptions | Get All Subscriptions +[**get_subscription**](ReportSubscriptionsApi.md#get_subscription) | **GET** /reporting/v3/report-subscriptions/{reportName} | Get Subscription for Report Name + + +# **create_standard_or_classic_subscription** +> create_standard_or_classic_subscription(predefined_subscription_request_bean, organization_id=organization_id) + +Create a Standard or Classic Subscription + +Create or update an already existing classic or standard subscription. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportSubscriptionsApi() +predefined_subscription_request_bean = CyberSource.PredefinedSubscriptionRequestBean() # PredefinedSubscriptionRequestBean | Report subscription request payload +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Create a Standard or Classic Subscription + api_instance.create_standard_or_classic_subscription(predefined_subscription_request_bean, organization_id=organization_id) +except ApiException as e: + print("Exception when calling ReportSubscriptionsApi->create_standard_or_classic_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **predefined_subscription_request_bean** | [**PredefinedSubscriptionRequestBean**](PredefinedSubscriptionRequestBean.md)| Report subscription request payload | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_subscription** +> create_subscription(create_report_subscription_request, organization_id=organization_id) + +Create Report Subscription for a Report Name by Organization + +Create a report subscription for your organization. The report name must be unique. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportSubscriptionsApi() +create_report_subscription_request = CyberSource.CreateReportSubscriptionRequest() # CreateReportSubscriptionRequest | Report subscription request payload +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Create Report Subscription for a Report Name by Organization + api_instance.create_subscription(create_report_subscription_request, organization_id=organization_id) +except ApiException as e: + print("Exception when calling ReportSubscriptionsApi->create_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_report_subscription_request** | [**CreateReportSubscriptionRequest**](CreateReportSubscriptionRequest.md)| Report subscription request payload | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_subscription** +> delete_subscription(report_name, organization_id=organization_id) + +Delete Subscription of a Report Name by Organization + +Delete a report subscription for your organization. You must know the unique name of the report you want to delete. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportSubscriptionsApi() +report_name = 'report_name_example' # str | Name of the Report to Delete +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Delete Subscription of a Report Name by Organization + api_instance.delete_subscription(report_name, organization_id=organization_id) +except ApiException as e: + print("Exception when calling ReportSubscriptionsApi->delete_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_name** | **str**| Name of the Report to Delete | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_subscriptions** +> ReportingV3ReportSubscriptionsGet200Response get_all_subscriptions(organization_id=organization_id) + +Get All Subscriptions + +View a summary of all report subscriptions. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportSubscriptionsApi() +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Get All Subscriptions + api_response = api_instance.get_all_subscriptions(organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling ReportSubscriptionsApi->get_all_subscriptions: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +[**ReportingV3ReportSubscriptionsGet200Response**](ReportingV3ReportSubscriptionsGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_subscription** +> ReportingV3ReportSubscriptionsGet200ResponseSubscriptions get_subscription(report_name, organization_id=organization_id) + +Get Subscription for Report Name + +View the details of a report subscription, such as the report format or report frequency, using the report's unique name. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportSubscriptionsApi() +report_name = 'report_name_example' # str | Name of the Report to Retrieve +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Get Subscription for Report Name + api_response = api_instance.get_subscription(report_name, organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling ReportSubscriptionsApi->get_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_name** | **str**| Name of the Report to Retrieve | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +[**ReportingV3ReportSubscriptionsGet200ResponseSubscriptions**](ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ReportingV3ChargebackDetailsGet200Response.md b/docs/ReportingV3ChargebackDetailsGet200Response.md new file mode 100644 index 00000000..4b6b0e1c --- /dev/null +++ b/docs/ReportingV3ChargebackDetailsGet200Response.md @@ -0,0 +1,13 @@ +# ReportingV3ChargebackDetailsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | Organization Id | [optional] +**start_time** | **datetime** | Report Start Date (ISO 8601 Extended) | [optional] +**end_time** | **datetime** | Report Start Date (ISO 8601 Extended) | [optional] +**chargeback_details** | [**list[ReportingV3ChargebackDetailsGet200ResponseChargebackDetails]**](ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md) | List of Chargeback Details list. | [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/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md b/docs/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md new file mode 100644 index 00000000..7d44d9e2 --- /dev/null +++ b/docs/ReportingV3ChargebackDetailsGet200ResponseChargebackDetails.md @@ -0,0 +1,32 @@ +# ReportingV3ChargebackDetailsGet200ResponseChargebackDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processor_merchant_id** | **str** | Processor Merchant Id | [optional] +**merchant_name** | **str** | Merchant Name | [optional] +**transaction_reference_number** | **str** | Transaction Reference Number | [optional] +**merchant_reference_number** | **str** | Merchant Reference Number | [optional] +**nature_of_dispute** | **str** | Nature of Dispute | [optional] +**alert_type** | **str** | Chargeback Alert Type | [optional] +**amount** | **str** | Chargeback Amount | [optional] +**sign** | **str** | Chargeback Sign | [optional] +**action** | **str** | Chargeback Action | [optional] +**card_type** | **str** | Card Type | [optional] +**original_settlement_time** | **datetime** | Original Settlement Date | [optional] +**tracking_number** | **str** | Tracking Number | [optional] +**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] +**request_id** | **str** | Request Id | [optional] +**response_due_time** | **datetime** | Response Due Date | [optional] +**time** | **datetime** | Chargeback Date | [optional] +**action_description** | **str** | Chargeback Action Description | [optional] +**customer_id** | **str** | Customer Id | [optional] +**reason_code** | **str** | Chargeback Reason Code | [optional] +**representment_cp_time** | **datetime** | Representment CP Date | [optional] +**applications** | **str** | ICS Request Applications | [optional] +**event_requested_time** | **datetime** | Event Request Date | [optional] +**pre_dispute_flag** | **str** | Pre Dispute Flag | [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/ReportingV3ChargebackSummariesGet200Response.md b/docs/ReportingV3ChargebackSummariesGet200Response.md new file mode 100644 index 00000000..729e54c3 --- /dev/null +++ b/docs/ReportingV3ChargebackSummariesGet200Response.md @@ -0,0 +1,13 @@ +# ReportingV3ChargebackSummariesGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | Organization Id | [optional] +**start_time** | **datetime** | Report Start Date | [optional] +**end_time** | **str** | Report Start Date | [optional] +**chargeback_summaries** | [**list[ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries]**](ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md) | List of Summary values | [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/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md b/docs/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md new file mode 100644 index 00000000..4fd0253a --- /dev/null +++ b/docs/ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md @@ -0,0 +1,12 @@ +# ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **float** | Chargeback summary list count | [optional] +**time** | **datetime** | Summary Date | [optional] +**account_id** | **str** | Account 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/ReportingV3ConversionDetailsGet200Response.md b/docs/ReportingV3ConversionDetailsGet200Response.md new file mode 100644 index 00000000..8b1ee4a0 --- /dev/null +++ b/docs/ReportingV3ConversionDetailsGet200Response.md @@ -0,0 +1,13 @@ +# ReportingV3ConversionDetailsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | Merchant Id | [optional] +**start_time** | **datetime** | | [optional] +**end_time** | **datetime** | | [optional] +**conversion_details** | [**list[ReportingV3ConversionDetailsGet200ResponseConversionDetails]**](ReportingV3ConversionDetailsGet200ResponseConversionDetails.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/ReportingV3ConversionDetailsGet200ResponseConversionDetails.md b/docs/ReportingV3ConversionDetailsGet200ResponseConversionDetails.md new file mode 100644 index 00000000..a83748f6 --- /dev/null +++ b/docs/ReportingV3ConversionDetailsGet200ResponseConversionDetails.md @@ -0,0 +1,19 @@ +# ReportingV3ConversionDetailsGet200ResponseConversionDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_reference_number** | **str** | Merchant reference number of a merchant | [optional] +**conversion_time** | **datetime** | Date of conversion | [optional] +**request_id** | **str** | Cybersource Transation request id | [optional] +**original_decision** | **str** | Original decision | [optional] +**new_decision** | **str** | New decision | [optional] +**reviewer** | **str** | User name of the reviewer | [optional] +**reviewer_comments** | **str** | Comments of the reviewer | [optional] +**queue** | **str** | Name of the queue | [optional] +**profile** | **str** | Name of the profile | [optional] +**notes** | [**list[ReportingV3ConversionDetailsGet200ResponseNotes]**](ReportingV3ConversionDetailsGet200ResponseNotes.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/ReportingV3ConversionDetailsGet200ResponseNotes.md b/docs/ReportingV3ConversionDetailsGet200ResponseNotes.md new file mode 100644 index 00000000..7ad7bb33 --- /dev/null +++ b/docs/ReportingV3ConversionDetailsGet200ResponseNotes.md @@ -0,0 +1,12 @@ +# ReportingV3ConversionDetailsGet200ResponseNotes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **datetime** | Time of the note added by reviewer | [optional] +**added_by** | **str** | Note added by reviewer | [optional] +**comments** | **str** | Comments given by the reviewer | [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/ReportingV3InterchangeClearingLevelDetailsGet200Response.md b/docs/ReportingV3InterchangeClearingLevelDetailsGet200Response.md new file mode 100644 index 00000000..1758fdbf --- /dev/null +++ b/docs/ReportingV3InterchangeClearingLevelDetailsGet200Response.md @@ -0,0 +1,12 @@ +# ReportingV3InterchangeClearingLevelDetailsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **datetime** | Valid report Start Date in **ISO 8601 format**. Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | [optional] +**end_date** | **datetime** | Valid report Start Date in **ISO 8601 format**. | [optional] +**interchange_clearing_level_details** | [**list[ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails]**](ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md) | List of InterchangeClearingLevelDetail | [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/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md b/docs/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md new file mode 100644 index 00000000..c5b1ddad --- /dev/null +++ b/docs/ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails.md @@ -0,0 +1,60 @@ +# ReportingV3InterchangeClearingLevelDetailsGet200ResponseInterchangeClearingLevelDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**processor_merchant_id** | **str** | | [optional] +**transaction_reference_number** | **str** | | [optional] +**merchant_reference_number** | **str** | | [optional] +**account_suffix** | **str** | | [optional] +**payment_sub_type** | **str** | | [optional] +**payment_sub_type_description** | **str** | | [optional] +**transaction_time** | **datetime** | | [optional] +**processed_time** | **datetime** | | [optional] +**transaction_type** | **str** | | [optional] +**amount** | **str** | | [optional] +**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] +**price_type** | **str** | | [optional] +**price_amount_one** | **str** | | [optional] +**price_amount_two** | **str** | | [optional] +**re_class** | **str** | | [optional] +**settlement_time** | **datetime** | | [optional] +**settlement_processor** | **str** | | [optional] +**merchant_batch_number** | **str** | | [optional] +**cleared_level** | **str** | | [optional] +**billback_reason_code** | **str** | | [optional] +**billback_reason_description** | **str** | | [optional] +**merchant_priced_level** | **str** | | [optional] +**discount_rate** | **str** | | [optional] +**discount_amount** | **str** | | [optional] +**clearing_rate_amount_one** | **str** | | [optional] +**clearing_rate_amount_two** | **str** | | [optional] +**clearing_rate_amount_three** | **str** | | [optional] +**clearing_rate_currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] +**interchange_amount** | **str** | | [optional] +**billback_amount** | **str** | | [optional] +**settlement_amount** | **str** | | [optional] +**settlement_currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] +**conversion_rate** | **str** | | [optional] +**delta_cost** | **str** | | [optional] +**surcharge_amount** | **str** | | [optional] +**percent_rate_charged** | **str** | | [optional] +**per_transaction_charged** | **str** | | [optional] +**downgrade_reason_code** | **str** | | [optional] +**process_time** | **datetime** | | [optional] +**auth_code** | **str** | | [optional] +**batch_time** | **datetime** | | [optional] +**processor_batch_number** | **str** | | [optional] +**card_indicator** | **str** | | [optional] +**minimum_unit** | **int** | | [optional] +**minimum_unit_currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] +**credit_delta_indicator** | **str** | | [optional] +**fee_category** | **str** | | [optional] +**application_name** | **str** | | [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/ReportingV3NetFundingsGet200Response.md b/docs/ReportingV3NetFundingsGet200Response.md new file mode 100644 index 00000000..863512b4 --- /dev/null +++ b/docs/ReportingV3NetFundingsGet200Response.md @@ -0,0 +1,17 @@ +# ReportingV3NetFundingsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_time** | **datetime** | Valid report Start Date in **ISO 8601 format**. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | [optional] +**end_time** | **datetime** | Valid report End Date in **ISO 8601 format** **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | [optional] +**net_funding_summaries** | [**list[ReportingV3NetFundingsGet200ResponseNetFundingSummaries]**](ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md) | List of Netfunding summary objects | [optional] +**total_purchases** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of total purchases currency wise | [optional] +**total_refunds** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of total refunds currency wise | [optional] +**total_fees** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of total fees currency wise | [optional] +**total_chargebacks** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of total chargebacks currency wise | [optional] +**net_total** | [**list[ReportingV3NetFundingsGet200ResponseTotalPurchases]**](ReportingV3NetFundingsGet200ResponseTotalPurchases.md) | List of new total currency wise | [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/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md b/docs/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md new file mode 100644 index 00000000..794faf4a --- /dev/null +++ b/docs/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.md @@ -0,0 +1,17 @@ +# ReportingV3NetFundingsGet200ResponseNetFundingSummaries + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Valid values: - PURCHASES - REFUNDS - FEES - CHARGEBACKS | [optional] +**payment_sub_type** | **str** | | [optional] +**conveyed_count** | **int** | | [optional] +**conveyed_amount** | **str** | | [optional] +**settled_count** | **int** | | [optional] +**funded_count** | **int** | | [optional] +**funded_amount** | **str** | | [optional] +**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency 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/ReportingV3NetFundingsGet200ResponseTotalPurchases.md b/docs/ReportingV3NetFundingsGet200ResponseTotalPurchases.md new file mode 100644 index 00000000..21fab57b --- /dev/null +++ b/docs/ReportingV3NetFundingsGet200ResponseTotalPurchases.md @@ -0,0 +1,11 @@ +# ReportingV3NetFundingsGet200ResponseTotalPurchases + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **str** | Valid ISO 4217 ALPHA-3 currency code | +**value** | **str** | | + +[[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/ReportingV3NotificationofChangesGet200Response.md b/docs/ReportingV3NotificationofChangesGet200Response.md new file mode 100644 index 00000000..6ef1e661 --- /dev/null +++ b/docs/ReportingV3NotificationofChangesGet200Response.md @@ -0,0 +1,10 @@ +# ReportingV3NotificationofChangesGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notification_of_changes** | [**list[ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges]**](ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md) | List of Notification Of Change Info values | [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/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md b/docs/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md new file mode 100644 index 00000000..e490b3c2 --- /dev/null +++ b/docs/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.md @@ -0,0 +1,17 @@ +# ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_reference_number** | **str** | Merchant Reference Number | [optional] +**transaction_reference_number** | **str** | Transaction Reference Number | [optional] +**time** | **datetime** | Notification Of Change Date(ISO 8601 Extended) | [optional] +**code** | **str** | Merchant Reference Number | [optional] +**account_type** | **str** | Account Type | [optional] +**routing_number** | **str** | Routing Number | [optional] +**account_number** | **str** | Account Number | [optional] +**consumer_name** | **str** | Consumer Name | [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/ReportingV3PaymentBatchSummariesGet200Response.md b/docs/ReportingV3PaymentBatchSummariesGet200Response.md new file mode 100644 index 00000000..58ec9ce0 --- /dev/null +++ b/docs/ReportingV3PaymentBatchSummariesGet200Response.md @@ -0,0 +1,12 @@ +# ReportingV3PaymentBatchSummariesGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_time** | **datetime** | | [optional] +**end_time** | **datetime** | | [optional] +**payment_batch_summaries** | [**list[ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries]**](ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.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/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md b/docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md new file mode 100644 index 00000000..0ff1f650 --- /dev/null +++ b/docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md @@ -0,0 +1,21 @@ +# ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency_code** | **str** | | [optional] +**payment_sub_type_description** | **str** | | [optional] +**start_time** | **datetime** | | [optional] +**end_time** | **datetime** | | [optional] +**sales_count** | **int** | | [optional] +**sales_amount** | **str** | | [optional] +**credit_count** | **int** | | [optional] +**credit_amount** | **str** | | [optional] +**account_name** | **str** | | [optional] +**account_id** | **str** | | [optional] +**merchant_id** | **str** | | [optional] +**merchant_name** | **str** | | [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/ReportingV3PurchaseRefundDetailsGet200Response.md b/docs/ReportingV3PurchaseRefundDetailsGet200Response.md new file mode 100644 index 00000000..c562b2a7 --- /dev/null +++ b/docs/ReportingV3PurchaseRefundDetailsGet200Response.md @@ -0,0 +1,18 @@ +# ReportingV3PurchaseRefundDetailsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**offset** | **int** | | [optional] +**limit** | **int** | | [optional] +**page_results** | **int** | | [optional] +**request_details** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails]**](ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md) | List of Request Info values | [optional] +**settlements** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseSettlements]**](ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md) | List of Settlement Info values | [optional] +**authorizations** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations]**](ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md) | List of Authorization Info values | [optional] +**fee_and_funding_details** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails]**](ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md) | List of Fee Funding Info values | [optional] +**others** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseOthers]**](ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md) | List of Other Info values | [optional] +**settlement_statuses** | [**list[ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses]**](ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md) | List of Settlement Status Info values | [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/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md new file mode 100644 index 00000000..76f4fae2 --- /dev/null +++ b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.md @@ -0,0 +1,17 @@ +# ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**transaction_reference_number** | **str** | Authorization Transaction Reference Number | [optional] +**time** | **datetime** | Authorization Date | [optional] +**authorization_request_id** | **str** | Authorization Request Id | [optional] +**amount** | **str** | Authorization Amount | [optional] +**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] +**code** | **str** | Authorization Code | [optional] +**rcode** | **str** | Authorization RCode | [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/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md new file mode 100644 index 00000000..1c7fd22a --- /dev/null +++ b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md @@ -0,0 +1,22 @@ +# ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**interchange_per_item_fee** | **str** | interchange Per Item Fee | [optional] +**interchange_description** | **str** | interchange Description | [optional] +**interchange_percentage** | **str** | interchange Percentage | [optional] +**interchange_percentage_amount** | **str** | interchange Percentage Amount | [optional] +**discount_percentage** | **str** | Discount Percentage | [optional] +**discount_amount** | **str** | Discount Amount | [optional] +**discount_per_item_fee** | **str** | Discount Per Item Fee | [optional] +**total_fee** | **str** | Total Fee | [optional] +**fee_currency** | **str** | Fee Currency | [optional] +**dues_assessments** | **str** | Dues Assessments | [optional] +**funding_amount** | **str** | Funding Amount | [optional] +**funding_currency** | **str** | Funding Currency (ISO 4217) | [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/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md new file mode 100644 index 00000000..ec4838bb --- /dev/null +++ b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.md @@ -0,0 +1,16 @@ +# ReportingV3PurchaseRefundDetailsGet200ResponseOthers + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**merchant_data1** | **str** | Merchant Defined Data | [optional] +**merchant_data2** | **str** | Merchant Defined Data | [optional] +**merchant_data3** | **str** | Merchant Defined Data | [optional] +**merchant_data4** | **str** | Merchant Defined Data | [optional] +**first_name** | **str** | First Name | [optional] +**last_name** | **str** | Last Name | [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/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md new file mode 100644 index 00000000..ec62329b --- /dev/null +++ b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.md @@ -0,0 +1,15 @@ +# ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**cybersource_merchant_id** | **str** | Cybersource Merchant Id | [optional] +**processor_merchant_id** | **str** | Cybersource Processor Merchant Id | [optional] +**group_name** | **str** | Group Name | [optional] +**transaction_reference_number** | **str** | Transaction Reference Number | [optional] +**merchant_reference_number** | **str** | Merchant Reference Number | [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/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md new file mode 100644 index 00000000..8309a571 --- /dev/null +++ b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.md @@ -0,0 +1,14 @@ +# ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**status** | **str** | Settlement Status | [optional] +**settlement_time** | **datetime** | Settlement Date | [optional] +**reason_code** | **str** | ReasonCode | [optional] +**error_text** | **str** | errorText | [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/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md new file mode 100644 index 00000000..44461954 --- /dev/null +++ b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.md @@ -0,0 +1,22 @@ +# ReportingV3PurchaseRefundDetailsGet200ResponseSettlements + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**transaction_type** | **str** | Transaction Type | [optional] +**submission_time** | **datetime** | Submission Date | [optional] +**amount** | **str** | Amount | [optional] +**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] +**payment_method** | **str** | payment method | [optional] +**wallet_type** | **str** | Solution Type (Wallet) | [optional] +**payment_type** | **str** | Payment Type | [optional] +**account_suffix** | **str** | Account Suffix | [optional] +**cybersource_batch_time** | **datetime** | Cybersource Batch Time | [optional] +**cybersource_batch_id** | **str** | Cybersource Batch Id | [optional] +**card_type** | **str** | Card Type | [optional] +**debit_network** | **str** | Debit 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/ReportingV3ReportDefinitionsGet200Response.md b/docs/ReportingV3ReportDefinitionsGet200Response.md new file mode 100644 index 00000000..40690f6c --- /dev/null +++ b/docs/ReportingV3ReportDefinitionsGet200Response.md @@ -0,0 +1,10 @@ +# ReportingV3ReportDefinitionsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_definitions** | [**list[ReportingV3ReportDefinitionsGet200ResponseReportDefinitions]**](ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.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/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.md b/docs/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.md new file mode 100644 index 00000000..def78160 --- /dev/null +++ b/docs/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.md @@ -0,0 +1,16 @@ +# ReportingV3ReportDefinitionsGet200ResponseReportDefinitions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] +**report_definition_id** | **int** | | Id | Definition Class | | --- | --------------------------------- | | 210 | TransactionRequestClass | | 211 | PaymentBatchDetailClass | | 212 | ExceptionDetailClass | | 213 | ProcessorSettlementDetailClass | | 214 | ProcessorEventsDetailClass | | 215 | FundingDetailClass | | 216 | AgingDetailClass | | 217 | ChargebackAndRetrievalDetailClass | | 218 | DepositDetailClass | | 219 | FeeDetailClass | | 220 | InvoiceSummaryClass | | 221 | PayerAuthDetailClass | | 222 | ConversionDetailClass | | 225 | BillableTransactionsDetailClass | | 270 | JPTransactionDetailClass | | 271 | ServiceFeeDetailClass | | 310 | GatewayTransactionRequestClass | | 400 | DecisionManagerEventDetailClass | | 401 | DecisionManagerDetailClass | | 410 | FeeSummaryClass | | 420 | TaxCalculationClass | | 520 | POSTerminalExceptionClass | | 620 | SubscriptionDetailClass | | [optional] +**report_defintion_name** | **str** | | [optional] +**supported_formats** | **list[str]** | | [optional] +**description** | **str** | | [optional] +**default_settings** | [**ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings**](ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md) | | [optional] +**subscription_type** | **str** | 'The subscription type for which report definition is required. By default the type will be CUSTOM.' Valid Values: - CLASSIC - CUSTOM - STANDARD | [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/ReportingV3ReportDefinitionsNameGet200Response.md b/docs/ReportingV3ReportDefinitionsNameGet200Response.md new file mode 100644 index 00000000..185dc083 --- /dev/null +++ b/docs/ReportingV3ReportDefinitionsNameGet200Response.md @@ -0,0 +1,17 @@ +# ReportingV3ReportDefinitionsNameGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] +**report_definition_id** | **int** | | [optional] +**report_defintion_name** | **str** | | [optional] +**attributes** | [**list[ReportingV3ReportDefinitionsNameGet200ResponseAttributes]**](ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md) | | [optional] +**supported_formats** | **list[str]** | | [optional] +**description** | **str** | | [optional] +**default_settings** | [**ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings**](ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md) | | [optional] +**subscription_type** | **str** | 'The subscription type for which report definition is required. By default the type will be CUSTOM.' Valid Values: - 'CLASSIC' - 'CUSTOM' - 'STANDARD' | [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/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md b/docs/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md new file mode 100644 index 00000000..3d6cc430 --- /dev/null +++ b/docs/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.md @@ -0,0 +1,16 @@ +# ReportingV3ReportDefinitionsNameGet200ResponseAttributes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**filter_type** | **str** | Attribute Filter Type. | [optional] +**default** | **bool** | | [optional] +**required** | **bool** | | [optional] +**supported_type** | **str** | Valid values for the filter. | [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/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md b/docs/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md new file mode 100644 index 00000000..539ff30c --- /dev/null +++ b/docs/ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings.md @@ -0,0 +1,17 @@ +# ReportingV3ReportDefinitionsNameGet200ResponseDefaultSettings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_mime_type** | **str** | Report Format Valid values: - application/xml - text/csv | [optional] +**report_frequency** | **str** | Report Frequency Value Valid Values: - DAILY - WEEKLY - MONTHLY - ADHOC | [optional] +**report_name** | **str** | Report Name | [optional] +**timezone** | **str** | Time Zone | [optional] +**start_time** | **str** | Start Time | [optional] +**start_day** | **int** | Start Day | [optional] +**report_filters** | **dict(str, list[str])** | List of filters to apply | [optional] +**report_preferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.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/ReportingV3ReportSubscriptionsGet200Response.md b/docs/ReportingV3ReportSubscriptionsGet200Response.md new file mode 100644 index 00000000..11fefe22 --- /dev/null +++ b/docs/ReportingV3ReportSubscriptionsGet200Response.md @@ -0,0 +1,10 @@ +# ReportingV3ReportSubscriptionsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptions** | [**list[ReportingV3ReportSubscriptionsGet200ResponseSubscriptions]**](ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.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/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md b/docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md new file mode 100644 index 00000000..421a2221 --- /dev/null +++ b/docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md @@ -0,0 +1,23 @@ +# ReportingV3ReportSubscriptionsGet200ResponseSubscriptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | Selected Organization Id | [optional] +**report_definition_id** | **str** | Report Definition Id | [optional] +**report_definition_name** | **str** | Report Definition Class | [optional] +**report_mime_type** | **str** | Report Format Valid values: - application/xml - text/csv | [optional] +**report_frequency** | **str** | 'Report Frequency' **NOTE: Do not document USER_DEFINED Frequency field in developer center** Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED | [optional] +**report_interval** | **str** | If the reportFrequency is User-defined, reportInterval should be in **ISO 8601 time format** Please refer the following link to know more about ISO 8601 format.[Rfc Time Format](https://en.wikipedia.org/wiki/ISO_8601#Durations) **Example time format for 2 hours and 30 Mins:** - PT2H30M **NOTE: Do not document reportInterval field in developer center** | [optional] +**report_name** | **str** | Report Name | [optional] +**timezone** | **str** | Time Zone | [optional] +**start_time** | **datetime** | Start Time | [optional] +**start_day** | **int** | Start Day | [optional] +**report_fields** | **list[str]** | List of all fields String values | [optional] +**report_filters** | **dict(str, list[str])** | List of filters to apply | [optional] +**report_preferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.md) | | [optional] +**group_id** | **str** | Id for the selected group. | [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/ReportingV3ReportsGet200Response.md b/docs/ReportingV3ReportsGet200Response.md new file mode 100644 index 00000000..6e148dde --- /dev/null +++ b/docs/ReportingV3ReportsGet200Response.md @@ -0,0 +1,10 @@ +# ReportingV3ReportsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_search_results** | [**list[ReportingV3ReportsGet200ResponseReportSearchResults]**](ReportingV3ReportsGet200ResponseReportSearchResults.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/ReportingV3ReportsGet200ResponseLink.md b/docs/ReportingV3ReportsGet200ResponseLink.md new file mode 100644 index 00000000..9b4da9de --- /dev/null +++ b/docs/ReportingV3ReportsGet200ResponseLink.md @@ -0,0 +1,10 @@ +# ReportingV3ReportsGet200ResponseLink + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_download** | [**ReportingV3ReportsGet200ResponseLinkReportDownload**](ReportingV3ReportsGet200ResponseLinkReportDownload.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/ReportingV3ReportsGet200ResponseLinkReportDownload.md b/docs/ReportingV3ReportsGet200ResponseLinkReportDownload.md new file mode 100644 index 00000000..82869790 --- /dev/null +++ b/docs/ReportingV3ReportsGet200ResponseLinkReportDownload.md @@ -0,0 +1,11 @@ +# ReportingV3ReportsGet200ResponseLinkReportDownload + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | | [optional] +**method** | **str** | | [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/ReportingV3ReportsGet200ResponseReportSearchResults.md b/docs/ReportingV3ReportsGet200ResponseReportSearchResults.md new file mode 100644 index 00000000..46275602 --- /dev/null +++ b/docs/ReportingV3ReportsGet200ResponseReportSearchResults.md @@ -0,0 +1,25 @@ +# ReportingV3ReportsGet200ResponseReportSearchResults + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**link** | [**ReportingV3ReportsGet200ResponseLink**](ReportingV3ReportsGet200ResponseLink.md) | | [optional] +**report_definition_id** | **str** | Unique Report Identifier of each report type | [optional] +**report_name** | **str** | Name of the report specified by merchant while creating the report | [optional] +**report_mime_type** | **str** | Format of the report to get generated Valid Values: - application/xml - text/csv | [optional] +**report_frequency** | **str** | Frequency of the report to get generated Valid Values: - DAILY - WEEKLY - MONTHLY - ADHOC | [optional] +**status** | **str** | Status of the report Valid Values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA | [optional] +**report_start_time** | **datetime** | Specifies the report start time in ISO 8601 format | [optional] +**report_end_time** | **datetime** | Specifies the report end time in ISO 8601 format | [optional] +**timezone** | **str** | Time Zone | [optional] +**report_id** | **str** | Unique identifier generated for every reports | [optional] +**organization_id** | **str** | CyberSource Merchant Id | [optional] +**queued_time** | **datetime** | Specifies the time of the report in queued in ISO 8601 format | [optional] +**report_generating_time** | **datetime** | Specifies the time of the report started to generate in ISO 8601 format | [optional] +**report_completed_time** | **datetime** | Specifies the time of the report completed the generation in ISO 8601 format | [optional] +**subscription_type** | **str** | Specifies whether the subscription created is either Custom, Standard or Classic | [optional] +**group_id** | **str** | Id for selected group. | [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/ReportingV3ReportsIdGet200Response.md b/docs/ReportingV3ReportsIdGet200Response.md new file mode 100644 index 00000000..bd60e0dc --- /dev/null +++ b/docs/ReportingV3ReportsIdGet200Response.md @@ -0,0 +1,23 @@ +# ReportingV3ReportsIdGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | CyberSource merchant id | [optional] +**report_id** | **str** | Report ID Value | [optional] +**report_definition_id** | **str** | Report definition Id | [optional] +**report_name** | **str** | Report Name | [optional] +**report_mime_type** | **str** | Report Format Valid values: - application/xml - text/csv | [optional] +**report_frequency** | **str** | Report Frequency Value Valid values: - DAILY - WEEKLY - MONTHLY - ADHOC | [optional] +**report_fields** | **list[str]** | List of Integer Values | [optional] +**report_status** | **str** | Report Status Value Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA - RERUN | [optional] +**report_start_time** | **datetime** | Report Start Time Value | [optional] +**report_end_time** | **datetime** | Report End Time Value | [optional] +**timezone** | **str** | Time Zone Value | [optional] +**report_filters** | **dict(str, list[str])** | List of filters to apply | [optional] +**report_preferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.md) | | [optional] +**group_id** | **str** | Id for selected group. | [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/ReportingV3RetrievalDetailsGet200Response.md b/docs/ReportingV3RetrievalDetailsGet200Response.md new file mode 100644 index 00000000..2adbe4c6 --- /dev/null +++ b/docs/ReportingV3RetrievalDetailsGet200Response.md @@ -0,0 +1,13 @@ +# ReportingV3RetrievalDetailsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | Organization Id | [optional] +**start_time** | **datetime** | Report Start Date (ISO 8601 Extended) | [optional] +**end_time** | **datetime** | Report Start Date (ISO 8601 Extended) | [optional] +**retrieval_details** | [**list[ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails]**](ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md) | List of Retrieval Details list. | [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/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md b/docs/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md new file mode 100644 index 00000000..79bd3ce2 --- /dev/null +++ b/docs/ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails.md @@ -0,0 +1,31 @@ +# ReportingV3RetrievalDetailsGet200ResponseRetrievalDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processor_merchant_id** | **str** | Processor Merchant Id | [optional] +**merchant_name** | **str** | Merchant Name | [optional] +**transaction_reference_number** | **str** | Transaction Reference Number | [optional] +**merchant_reference_number** | **str** | Merchant Reference Number | [optional] +**nature_of_dispute** | **str** | Nature of Dispute | [optional] +**alert_type** | **str** | Retrieval Alert Type | [optional] +**amount** | **str** | Retrieval Amount | [optional] +**sign** | **str** | Retrieval Sign | [optional] +**action** | **str** | Retrieval Action | [optional] +**card_type** | **str** | Card Type | [optional] +**original_settlement_time** | **datetime** | Original Settlement Date | [optional] +**tracking_number** | **str** | Tracking Number | [optional] +**currency_code** | **str** | Valid ISO 4217 ALPHA-3 currency code | [optional] +**request_id** | **str** | Request Id | [optional] +**response_due_time** | **datetime** | Response Due Date | [optional] +**time** | **datetime** | Retrieval Date | [optional] +**action_description** | **str** | Retrieval Action Description | [optional] +**customer_id** | **str** | Customer Id | [optional] +**reason_code** | **str** | Retrieval Reason Code | [optional] +**representment_cp_time** | **datetime** | Representment CP Date | [optional] +**applications** | **str** | ICS Request Applications | [optional] +**event_requested_time** | **datetime** | Event Request Date | [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/ReportingV3RetrievalSummariesGet200Response.md b/docs/ReportingV3RetrievalSummariesGet200Response.md new file mode 100644 index 00000000..c684d111 --- /dev/null +++ b/docs/ReportingV3RetrievalSummariesGet200Response.md @@ -0,0 +1,13 @@ +# ReportingV3RetrievalSummariesGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | Organization Id | [optional] +**start_time** | **datetime** | Report Start Date | [optional] +**end_time** | **str** | Report Start Date | [optional] +**retrieval_summaries** | [**list[ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries]**](ReportingV3ChargebackSummariesGet200ResponseChargebackSummaries.md) | List of Summary values | [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/Reportingv3ReportDownloadsGet400Response.md b/docs/Reportingv3ReportDownloadsGet400Response.md new file mode 100644 index 00000000..4530b58a --- /dev/null +++ b/docs/Reportingv3ReportDownloadsGet400Response.md @@ -0,0 +1,13 @@ +# Reportingv3ReportDownloadsGet400Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **datetime** | Time of request in UTC. | +**reason** | **str** | Documented reason code | +**message** | **str** | Short descriptive message to the user. | +**details** | [**list[Reportingv3ReportDownloadsGet400ResponseDetails]**](Reportingv3ReportDownloadsGet400ResponseDetails.md) | Error field list | + +[[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/Reportingv3ReportDownloadsGet400ResponseDetails.md b/docs/Reportingv3ReportDownloadsGet400ResponseDetails.md new file mode 100644 index 00000000..54a45676 --- /dev/null +++ b/docs/Reportingv3ReportDownloadsGet400ResponseDetails.md @@ -0,0 +1,11 @@ +# Reportingv3ReportDownloadsGet400ResponseDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**field** | **str** | Field in request that caused an error | [optional] +**reason** | **str** | Documented reason 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/Reportingv3reportsReportFilters.md b/docs/Reportingv3reportsReportFilters.md new file mode 100644 index 00000000..7b18aee8 --- /dev/null +++ b/docs/Reportingv3reportsReportFilters.md @@ -0,0 +1,13 @@ +# Reportingv3reportsReportFilters + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_name** | **list[str]** | | [optional] +**first_name** | **list[str]** | | [optional] +**last_name** | **list[str]** | | [optional] +**email** | **list[str]** | | [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/Reportingv3reportsReportPreferences.md b/docs/Reportingv3reportsReportPreferences.md new file mode 100644 index 00000000..2ec28cf6 --- /dev/null +++ b/docs/Reportingv3reportsReportPreferences.md @@ -0,0 +1,11 @@ +# Reportingv3reportsReportPreferences + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**signed_amounts** | **bool** | Indicator to determine whether negative sign infront of amount for all refunded transaction | [optional] +**field_name_convention** | **str** | Specify the field naming convention to be followed in reports (applicable to only csv report formats) Valid values: - SOAPI - SCMP | [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/ReportsApi.md b/docs/ReportsApi.md new file mode 100644 index 00000000..cd7df787 --- /dev/null +++ b/docs/ReportsApi.md @@ -0,0 +1,174 @@ +# CyberSource.ReportsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_report**](ReportsApi.md#create_report) | **POST** /reporting/v3/reports | Create Adhoc Report +[**get_report_by_report_id**](ReportsApi.md#get_report_by_report_id) | **GET** /reporting/v3/reports/{reportId} | Get Report Based on Report Id +[**search_reports**](ReportsApi.md#search_reports) | **GET** /reporting/v3/reports | Retrieve Available Reports + + +# **create_report** +> create_report(create_adhoc_report_request, organization_id=organization_id) + +Create Adhoc Report + +Create a one-time report. You must specify the type of report in reportDefinitionName. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation) + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportsApi() +create_adhoc_report_request = CyberSource.CreateAdhocReportRequest() # CreateAdhocReportRequest | Report subscription request payload +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Create Adhoc Report + api_instance.create_report(create_adhoc_report_request, organization_id=organization_id) +except ApiException as e: + print("Exception when calling ReportsApi->create_report: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_adhoc_report_request** | [**CreateAdhocReportRequest**](CreateAdhocReportRequest.md)| Report subscription request payload | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_report_by_report_id** +> ReportingV3ReportsIdGet200Response get_report_by_report_id(report_id, organization_id=organization_id) + +Get Report Based on Report Id + +Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportsApi() +report_id = 'report_id_example' # str | Valid Report Id +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Get Report Based on Report Id + api_response = api_instance.get_report_by_report_id(report_id, organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling ReportsApi->get_report_by_report_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_id** | **str**| Valid Report Id | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +[**ReportingV3ReportsIdGet200Response**](ReportingV3ReportsIdGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json, application/xml + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_reports** +> ReportingV3ReportsGet200Response search_reports(start_time, end_time, time_query_type, organization_id=organization_id, report_mime_type=report_mime_type, report_frequency=report_frequency, report_name=report_name, report_definition_id=report_definition_id, report_status=report_status) + +Retrieve Available Reports + +Retrieve a list of the available reports to which you are subscribed. This will also give you the reportId value, which you can also use to download a report. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReportsApi() +start_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +end_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +time_query_type = 'time_query_type_example' # str | Specify time you would like to search Valid values: - reportTimeFrame - executedTime +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) +report_mime_type = 'report_mime_type_example' # str | Valid Report Format Valid values: - application/xml - text/csv (optional) +report_frequency = 'report_frequency_example' # str | Valid Report Frequency Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED - ADHOC (optional) +report_name = 'report_name_example' # str | Valid Report Name (optional) +report_definition_id = 56 # int | Valid Report Definition Id (optional) +report_status = 'report_status_example' # str | Valid Report Status Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA (optional) + +try: + # Retrieve Available Reports + api_response = api_instance.search_reports(start_time, end_time, time_query_type, organization_id=organization_id, report_mime_type=report_mime_type, report_frequency=report_frequency, report_name=report_name, report_definition_id=report_definition_id, report_status=report_status) + pprint(api_response) +except ApiException as e: + print("Exception when calling ReportsApi->search_reports: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **start_time** | **datetime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **end_time** | **datetime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **time_query_type** | **str**| Specify time you would like to search Valid values: - reportTimeFrame - executedTime | + **organization_id** | **str**| Valid Organization Id | [optional] + **report_mime_type** | **str**| Valid Report Format Valid values: - application/xml - text/csv | [optional] + **report_frequency** | **str**| Valid Report Frequency Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED - ADHOC | [optional] + **report_name** | **str**| Valid Report Name | [optional] + **report_definition_id** | **int**| Valid Report Definition Id | [optional] + **report_status** | **str**| Valid Report Status Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA | [optional] + +### Return type + +[**ReportingV3ReportsGet200Response**](ReportingV3ReportsGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Request.md b/docs/Request.md new file mode 100644 index 00000000..78ee2203 --- /dev/null +++ b/docs/Request.md @@ -0,0 +1,11 @@ +# Request + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processing_information** | [**Ptsv2paymenttokensProcessingInformation**](Ptsv2paymenttokensProcessingInformation.md) | | [optional] +**payment_information** | [**Ptsv2paymenttokensPaymentInformation**](Ptsv2paymenttokensPaymentInformation.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/ResourceNotFoundError.md b/docs/ResourceNotFoundError.md new file mode 100644 index 00000000..9def414e --- /dev/null +++ b/docs/ResourceNotFoundError.md @@ -0,0 +1,11 @@ +# ResourceNotFoundError + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **str** | | [optional] +**error_description** | **str** | | [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/RetrievalDetailsApi.md b/docs/RetrievalDetailsApi.md new file mode 100644 index 00000000..e12bad3a --- /dev/null +++ b/docs/RetrievalDetailsApi.md @@ -0,0 +1,61 @@ +# CyberSource.RetrievalDetailsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_retrieval_details**](RetrievalDetailsApi.md#get_retrieval_details) | **GET** /reporting/v3/retrieval-details | Get Retrieval Details + + +# **get_retrieval_details** +> ReportingV3RetrievalDetailsGet200Response get_retrieval_details(start_time, end_time, organization_id=organization_id) + +Get Retrieval Details + +Retrieval Detail Report Description + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.RetrievalDetailsApi() +start_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +end_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Get Retrieval Details + api_response = api_instance.get_retrieval_details(start_time, end_time, organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling RetrievalDetailsApi->get_retrieval_details: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **start_time** | **datetime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **end_time** | **datetime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +[**ReportingV3RetrievalDetailsGet200Response**](ReportingV3RetrievalDetailsGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json, application/xml + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RetrievalSummariesApi.md b/docs/RetrievalSummariesApi.md new file mode 100644 index 00000000..1467dbce --- /dev/null +++ b/docs/RetrievalSummariesApi.md @@ -0,0 +1,61 @@ +# CyberSource.RetrievalSummariesApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_retrieval_summary**](RetrievalSummariesApi.md#get_retrieval_summary) | **GET** /reporting/v3/retrieval-summaries | Get Retrieval Summaries + + +# **get_retrieval_summary** +> ReportingV3RetrievalSummariesGet200Response get_retrieval_summary(start_time, end_time, organization_id=organization_id) + +Get Retrieval Summaries + +Retrieval Summary Report Description + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.RetrievalSummariesApi() +start_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +end_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +organization_id = 'organization_id_example' # str | Valid Organization Id (optional) + +try: + # Get Retrieval Summaries + api_response = api_instance.get_retrieval_summary(start_time, end_time, organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling RetrievalSummariesApi->get_retrieval_summary: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **start_time** | **datetime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **end_time** | **datetime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **organization_id** | **str**| Valid Organization Id | [optional] + +### Return type + +[**ReportingV3RetrievalSummariesGet200Response**](ReportingV3RetrievalSummariesGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json, application/xml + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ReversalApi.md b/docs/ReversalApi.md new file mode 100644 index 00000000..2940240c --- /dev/null +++ b/docs/ReversalApi.md @@ -0,0 +1,108 @@ +# CyberSource.ReversalApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**auth_reversal**](ReversalApi.md#auth_reversal) | **POST** /pts/v2/payments/{id}/reversals | Process an Authorization Reversal +[**mit_reversal**](ReversalApi.md#mit_reversal) | **POST** /pts/v2/reversals | Timeout Reversal + + +# **auth_reversal** +> PtsV2PaymentsReversalsPost201Response auth_reversal(id, auth_reversal_request) + +Process an Authorization Reversal + +Include the payment ID in the POST request to reverse the payment amount. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReversalApi() +id = 'id_example' # str | The payment ID returned from a previous payment request. +auth_reversal_request = CyberSource.AuthReversalRequest() # AuthReversalRequest | + +try: + # Process an Authorization Reversal + api_response = api_instance.auth_reversal(id, auth_reversal_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling ReversalApi->auth_reversal: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The payment ID returned from a previous payment request. | + **auth_reversal_request** | [**AuthReversalRequest**](AuthReversalRequest.md)| | + +### Return type + +[**PtsV2PaymentsReversalsPost201Response**](PtsV2PaymentsReversalsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **mit_reversal** +> PtsV2PaymentsReversalsPost201Response mit_reversal(mit_reversal_request) + +Timeout Reversal + +This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.ReversalApi() +mit_reversal_request = CyberSource.MitReversalRequest() # MitReversalRequest | + +try: + # Timeout Reversal + api_response = api_instance.mit_reversal(mit_reversal_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling ReversalApi->mit_reversal: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mit_reversal_request** | [**MitReversalRequest**](MitReversalRequest.md)| | + +### Return type + +[**PtsV2PaymentsReversalsPost201Response**](PtsV2PaymentsReversalsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RiskProducts.md b/docs/RiskProducts.md new file mode 100644 index 00000000..0e51a563 --- /dev/null +++ b/docs/RiskProducts.md @@ -0,0 +1,12 @@ +# RiskProducts + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fraud_management_essentials** | [**RiskProductsFraudManagementEssentials**](RiskProductsFraudManagementEssentials.md) | | [optional] +**decision_manager** | [**RiskProductsDecisionManager**](RiskProductsDecisionManager.md) | | [optional] +**portfolio_risk_controls** | [**RiskProductsPortfolioRiskControls**](RiskProductsPortfolioRiskControls.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/RiskProductsDecisionManager.md b/docs/RiskProductsDecisionManager.md new file mode 100644 index 00000000..6173ba80 --- /dev/null +++ b/docs/RiskProductsDecisionManager.md @@ -0,0 +1,11 @@ +# RiskProductsDecisionManager + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscription_information** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional] +**configuration_information** | [**RiskProductsDecisionManagerConfigurationInformation**](RiskProductsDecisionManagerConfigurationInformation.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/RiskProductsDecisionManagerConfigurationInformation.md b/docs/RiskProductsDecisionManagerConfigurationInformation.md new file mode 100644 index 00000000..f4204797 --- /dev/null +++ b/docs/RiskProductsDecisionManagerConfigurationInformation.md @@ -0,0 +1,11 @@ +# RiskProductsDecisionManagerConfigurationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**template_id** | **str** | | [optional] +**configurations** | [**DmConfig**](DmConfig.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/RiskProductsFraudManagementEssentials.md b/docs/RiskProductsFraudManagementEssentials.md new file mode 100644 index 00000000..9af12224 --- /dev/null +++ b/docs/RiskProductsFraudManagementEssentials.md @@ -0,0 +1,11 @@ +# RiskProductsFraudManagementEssentials + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscription_information** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional] +**configuration_information** | [**RiskProductsFraudManagementEssentialsConfigurationInformation**](RiskProductsFraudManagementEssentialsConfigurationInformation.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/RiskProductsFraudManagementEssentialsConfigurationInformation.md b/docs/RiskProductsFraudManagementEssentialsConfigurationInformation.md new file mode 100644 index 00000000..76e4eb33 --- /dev/null +++ b/docs/RiskProductsFraudManagementEssentialsConfigurationInformation.md @@ -0,0 +1,10 @@ +# RiskProductsFraudManagementEssentialsConfigurationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**template_id** | **str** | | [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/RiskProductsPortfolioRiskControls.md b/docs/RiskProductsPortfolioRiskControls.md new file mode 100644 index 00000000..2f664f9d --- /dev/null +++ b/docs/RiskProductsPortfolioRiskControls.md @@ -0,0 +1,11 @@ +# RiskProductsPortfolioRiskControls + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscription_information** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) | | [optional] +**configuration_information** | [**RiskProductsPortfolioRiskControlsConfigurationInformation**](RiskProductsPortfolioRiskControlsConfigurationInformation.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/RiskProductsPortfolioRiskControlsConfigurationInformation.md b/docs/RiskProductsPortfolioRiskControlsConfigurationInformation.md new file mode 100644 index 00000000..5c3a43dd --- /dev/null +++ b/docs/RiskProductsPortfolioRiskControlsConfigurationInformation.md @@ -0,0 +1,10 @@ +# RiskProductsPortfolioRiskControlsConfigurationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**configurations** | [**RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations**](RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.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/RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.md b/docs/RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.md new file mode 100644 index 00000000..50276635 --- /dev/null +++ b/docs/RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations.md @@ -0,0 +1,10 @@ +# RiskProductsPortfolioRiskControlsConfigurationInformationConfigurations + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**profile_id** | **str** | | [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/RiskV1AddressVerificationsPost201Response.md b/docs/RiskV1AddressVerificationsPost201Response.md new file mode 100644 index 00000000..3daa1d5d --- /dev/null +++ b/docs/RiskV1AddressVerificationsPost201Response.md @@ -0,0 +1,18 @@ +# RiskV1AddressVerificationsPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**submit_time_local** | **str** | Time that the transaction was submitted in local time. Generated by Cybersource. | [optional] +**status** | **str** | The status for the call can be: - COMPLETED - INVALID_REQUEST - DECLINED | [optional] +**message** | **str** | The message describing the reason of the status. Value can be - Apartment number missing or not found. - Insufficient address information. - House/Box number not found on street. - Multiple address matches were found. - P.O. Box identifier not found or out of range. - Route service identifier not found or out of range. - Street name not found in Postal code. - Postal code not found in database. - Unable to verify or correct address. - Multiple addres matches were found (international) - Address match not found (no reason given) - Unsupported character set | [optional] +**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] +**address_verification_information** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md) | | [optional] +**error_information** | [**RiskV1AddressVerificationsPost201ResponseErrorInformation**](RiskV1AddressVerificationsPost201ResponseErrorInformation.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/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md new file mode 100644 index 00000000..4c3e659c --- /dev/null +++ b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md @@ -0,0 +1,17 @@ +# RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address_type** | **str** | 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] +**bar_code** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md) | | [optional] +**applicable_region** | **str** | 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] +**error_code** | **str** | 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] +**status_code** | **str** | Four-to-ten character status 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] +**care_of** | **str** | Care of data dropped from the standard address. | [optional] +**match_score** | **int** | Indicates the probable correctness of the address match. Returned for U.S. and Canadian addresses. Returns a value from 0-9, where 0 is most likely to be correct and 9 is least likely to be correct, or -1 if there is no address match. | [optional] +**standard_address** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.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/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md new file mode 100644 index 00000000..a897c01e --- /dev/null +++ b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode.md @@ -0,0 +1,11 @@ +# RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Delivery point bar code determined from the input address. | [optional] +**check_digit** | **float** | Check digit for the 11-digit delivery point bar 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/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.md new file mode 100644 index 00000000..3e8b0f7a --- /dev/null +++ b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress.md @@ -0,0 +1,20 @@ +# RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md) | | [optional] +**address2** | **str** | Second line of the standardized address. | [optional] +**address3** | **str** | Third line of the standardized address. | [optional] +**address4** | **str** | Fourth line of the standardized address. | [optional] +**locality** | **str** | Standardized city name. | [optional] +**county** | **str** | U.S. county if available. | [optional] +**country** | **str** | Standardized country name. | [optional] +**csz** | **str** | Standardized city, state or province, and ZIP +4 code or postal code line. | [optional] +**iso_country** | **str** | Standardized two-character ISO country code. | [optional] +**administrative_area** | **str** | U.S.P.S. standardized state or province abbreviation. | [optional] +**postal_code** | **str** | Standardized U.S. ZIP + 4 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/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md new file mode 100644 index 00000000..52d80fd9 --- /dev/null +++ b/docs/RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1.md @@ -0,0 +1,11 @@ +# RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddressAddress1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**with_apartment** | **str** | First line of the standardized address, including apartment information. | [optional] +**without_apartment** | **str** | First line of the standardized address, without apartment information. Returned for U.S. and Canadian addresses. | [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/RiskV1AddressVerificationsPost201ResponseErrorInformation.md b/docs/RiskV1AddressVerificationsPost201ResponseErrorInformation.md new file mode 100644 index 00000000..4ccb7ef7 --- /dev/null +++ b/docs/RiskV1AddressVerificationsPost201ResponseErrorInformation.md @@ -0,0 +1,12 @@ +# RiskV1AddressVerificationsPost201ResponseErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | The reason of the status. Value can be - `APARTMENT_NUMBER_NOT_FOUND` - `INSUFFICIENT_ADDRESS_INFORMATION` - `HOUSE_OR_BOX_NUMBER_NOT_FOUND` - `MULTIPLE_ADDRESS_MATCHES` - `BOX_NUMBER_NOT_FOUND` - `ROUTE_SERVICE_NOT_FOUND` - `STREET_NAME_NOT_FOUND` - `POSTAL_CODE_NOT_FOUND` - `UNVERIFIABLE_ADDRESS` - `MULTIPLE_ADDRESS_MATCHES_INTERNATIONAL` - `ADDRESS_MATCH_NOT_FOUND` - `UNSUPPORTED_CHARACTER_SET` - `INVALID_MERCHANT_CONFIGURATION` | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1AuthenticationResultsPost201Response.md b/docs/RiskV1AuthenticationResultsPost201Response.md new file mode 100644 index 00000000..847b7e82 --- /dev/null +++ b/docs/RiskV1AuthenticationResultsPost201Response.md @@ -0,0 +1,17 @@ +# RiskV1AuthenticationResultsPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `AUTHENTICATION_FAILED` | [optional] +**message** | **str** | The message describing the reason of the status. Value is: - The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction. | [optional] +**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] +**consumer_authentication_information** | [**RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation**](RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md) | | [optional] +**error_information** | [**RiskV1AuthenticationsPost201ResponseErrorInformation**](RiskV1AuthenticationsPost201ResponseErrorInformation.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/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md new file mode 100644 index 00000000..89a2cf89 --- /dev/null +++ b/docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md @@ -0,0 +1,40 @@ +# RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acs_rendering_type** | **str** | Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. | [optional] +**acs_reference_number** | **str** | Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval. | [optional] +**acs_transaction_id** | **str** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional] +**acs_operator_id** | **str** | Directory Server assigned ACS identifier. | [optional] +**authentication_result** | **str** | Raw authentication data that comes from the cardissuing bank. Primary authentication field that indicates if authentication was successful and if liability shift occurred. You should examine first the result of this field. This field contains one of these values: - `-1`: Invalid PARes. - `0`: Successful validation. - `1`: Cardholder is not participating, but the attempt to authenticate was recorded. - `6`: Issuer unable to perform authentication. - `9`: Cardholder did not complete authentication. | [optional] +**authentication_type** | **str** | 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] +**authentication_status_msg** | **str** | Message that explains the authenticationResult reply field. | [optional] +**authentication_transaction_id** | **str** | 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] +**authentication_transaction_context_id** | **str** | Payer authentication transaction identifier passed to link the validation and authorization calls. | [optional] +**transaction_token** | **str** | Web based token used to authenticate consumer with Rupay authentication provider. | [optional] +**authorization_payload** | **str** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional] +**cavv** | **str** | Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor. | [optional] +**cavv_algorithm** | **str** | Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard | [optional] +**challenge_cancel_code** | **str** | 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] +**directory_server_error_code** | **str** | The directory server error code indicating a problem with this transaction. Note - Max Length of this field is typically 3 characters. | [optional] +**directory_server_error_description** | **str** | Directory server text and additional detail about the error for this transaction. | [optional] +**effective_authentication_type** | **str** | This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer). | [optional] +**indicator** | **str** | Indicator used to differentiate Internet transactions from other types. The authentication failed if this field is not returned. For Visa, if your payment processor is Streamline, Barclays, AIBMS, or FDC Germany, you receive the value vbv_failure instead of internet when eci is 07. The value of this field is passed automatically to the authorization service if you request the services together. This field contains one of these values: - `aesk`: American Express SafeKey authentication verified successfully. - `aesk_attempted`: Card not enrolled in American Express SafeKey, but the attempt to authenticate was recorded. - `dipb`: Discover ProtectBuy authentication verified successfully. - `dipb_attempted`: Card not enrolled in Discover ProtectBuy, but the attempt to authenticate was recorded. - `internet`: Authentication was not verified successfully. - `js`: J/Secure authentication verified successfully. - `js_attempted`: Card not enrolled in J/Secure, but the attempt to authenticate was recorded. - `moto`: Mail or telephone order. - `pb_attempted`: Card not enrolled in Diners Club ProtectBuy, but the attempt to authenticate was recorded. - `recurring`: Recurring transaction. - `spa`: Mastercard Identity Check authentication verified successfully. - `spa_failure`: Mastercard Identity Check failed authentication. - `vbv`: Visa Secure authentication verified successfully. - `vbv_attempted`: Card not enrolled in Visa Secure, but the attempt to authenticate was recorded. - `vbv_failure`: Visa Secure authentication unavailable. | [optional] +**interaction_counter** | **str** | Indicates the number of authentication cycles attempted by the cardholder and is tracked by the Issuing Banks ACS.Example: if customer gets the challenge window and enter in their one time password and hit submit then that interaction counter should just be 1. When customer gets the challenge window and the bank asks if they want to have the one time password sent to their phone or their email and they have to choose before going to the next screen to enter in their one time password then this interaction count would be 2. One for the selection of how they want the one time password delivered and another with them actually entering in the one time password and hitting the submit button. | [optional] +**eci** | **str** | Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see \"Interpreting the Reply,\" page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.) | [optional] +**eci_raw** | **str** | ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of `eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover) | [optional] +**pares_status** | **str** | 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] +**sdk_transaction_id** | **str** | SDK unique transaction identifier that is generated on each new transaction. | [optional] +**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 | [optional] +**three_ds_server_transaction_id** | **str** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] +**ucaf_authentication_data** | **str** | 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] +**ucaf_collection_indicator** | **str** | 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] +**white_list_status** | **str** | Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder | [optional] +**white_list_status_source** | **str** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional] +**xid** | **str** | 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] +**directory_server_transaction_id** | **str** | 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] + +[[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/RiskV1AuthenticationSetupsPost201Response.md b/docs/RiskV1AuthenticationSetupsPost201Response.md new file mode 100644 index 00000000..47e786ea --- /dev/null +++ b/docs/RiskV1AuthenticationSetupsPost201Response.md @@ -0,0 +1,16 @@ +# RiskV1AuthenticationSetupsPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status for payerAuthentication 201 setup calls. Possible value is: - COMPLETED - FAILED | [optional] +**consumer_authentication_information** | [**RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation**](RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md) | | [optional] +**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] +**error_information** | [**RiskV1AuthenticationSetupsPost201ResponseErrorInformation**](RiskV1AuthenticationSetupsPost201ResponseErrorInformation.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/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md new file mode 100644 index 00000000..b42ce46b --- /dev/null +++ b/docs/RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md @@ -0,0 +1,12 @@ +# RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_token** | **str** | JSON Web Token (JWT) used to authenticate the consumer with the authentication provider, such as, CardinalCommerce or Rupay. Note - Max Length of this field is 2048 characters. | [optional] +**reference_id** | **str** | This identifier represents cardinal has started device data collection session and this must be passed in Authentication JWT to Cardinal when invoking the deviceDataCollectionUrl. | [optional] +**device_data_collection_url** | **str** | The deviceDataCollectionUrl is the location to send the Authentication JWT when invoking the Device Data collection process. | [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/RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md b/docs/RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md new file mode 100644 index 00000000..eaa3f4e2 --- /dev/null +++ b/docs/RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md @@ -0,0 +1,12 @@ +# RiskV1AuthenticationSetupsPost201ResponseErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | The reason of the status. Possible values: - EXPIRED_CARD - GENERAL_DECLINE | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1AuthenticationsPost201Response.md b/docs/RiskV1AuthenticationsPost201Response.md new file mode 100644 index 00000000..be9da0df --- /dev/null +++ b/docs/RiskV1AuthenticationsPost201Response.md @@ -0,0 +1,18 @@ +# RiskV1AuthenticationsPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `AUTHENTICATION_FAILED` | [optional] +**message** | **str** | The message describing the reason of the status. Value is: - The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction. | [optional] +**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] +**order_information** | [**RiskV1DecisionsPost201ResponseOrderInformation**](RiskV1DecisionsPost201ResponseOrderInformation.md) | | [optional] +**consumer_authentication_information** | [**RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation**](RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md) | | [optional] +**error_information** | [**RiskV1AuthenticationsPost201ResponseErrorInformation**](RiskV1AuthenticationsPost201ResponseErrorInformation.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/RiskV1AuthenticationsPost201ResponseErrorInformation.md b/docs/RiskV1AuthenticationsPost201ResponseErrorInformation.md new file mode 100644 index 00000000..c60209a6 --- /dev/null +++ b/docs/RiskV1AuthenticationsPost201ResponseErrorInformation.md @@ -0,0 +1,12 @@ +# RiskV1AuthenticationsPost201ResponseErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | The reason of the status. Possible values are: - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_REQUIRED` - `CONSUMER_AUTHENTICATION_FAILED` - `AUTHENTICATION_FAILED` | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1AuthenticationsPost400Response.md b/docs/RiskV1AuthenticationsPost400Response.md new file mode 100644 index 00000000..dbd46b69 --- /dev/null +++ b/docs/RiskV1AuthenticationsPost400Response.md @@ -0,0 +1,14 @@ +# RiskV1AuthenticationsPost400Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status for payerAuthentication 400 setup calls. Possible values are: - INVALID_REQUEST | [optional] +**reason** | **str** | The reason of the status. | [optional] +**message** | **str** | The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be setup. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1AuthenticationsPost400Response1.md b/docs/RiskV1AuthenticationsPost400Response1.md new file mode 100644 index 00000000..43cc4188 --- /dev/null +++ b/docs/RiskV1AuthenticationsPost400Response1.md @@ -0,0 +1,14 @@ +# RiskV1AuthenticationsPost400Response1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status for payerAuthentication 400 enroll and validate calls. Value is: - `INVALID_REQUEST` | [optional] +**reason** | **str** | The reason of the status. Possible Values: - `MISSING_FIELD` - `INVALID_DATA` | [optional] +**message** | **str** | The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be authenticated. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1DecisionsPost201Response.md b/docs/RiskV1DecisionsPost201Response.md new file mode 100644 index 00000000..a0ad045f --- /dev/null +++ b/docs/RiskV1DecisionsPost201Response.md @@ -0,0 +1,21 @@ +# RiskV1DecisionsPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2PaymentsPost201ResponseLinks**](PtsV2PaymentsPost201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**submit_time_local** | **str** | Time that the transaction was submitted in local time. Generated by Cybersource. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - `ACCEPTED` - `REJECTED` - `PENDING_REVIEW` - `DECLINED` - `PENDING_AUTHENTICATION` - `INVALID_REQUEST` - `AUTHENTICATION_FAILED` - `CHALLENGE` | [optional] +**risk_information** | [**PtsV2PaymentsPost201ResponseRiskInformation**](PtsV2PaymentsPost201ResponseRiskInformation.md) | | [optional] +**payment_information** | [**RiskV1DecisionsPost201ResponsePaymentInformation**](RiskV1DecisionsPost201ResponsePaymentInformation.md) | | [optional] +**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] +**order_information** | [**RiskV1DecisionsPost201ResponseOrderInformation**](RiskV1DecisionsPost201ResponseOrderInformation.md) | | [optional] +**consumer_authentication_information** | [**RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation**](RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md) | | [optional] +**watchlist_screening_information** | [**PtsV2PaymentsPost201ResponseWatchlistScreeningInformation**](PtsV2PaymentsPost201ResponseWatchlistScreeningInformation.md) | | [optional] +**error_information** | [**RiskV1DecisionsPost201ResponseErrorInformation**](RiskV1DecisionsPost201ResponseErrorInformation.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/RiskV1DecisionsPost201ResponseClientReferenceInformation.md b/docs/RiskV1DecisionsPost201ResponseClientReferenceInformation.md new file mode 100644 index 00000000..1e84773a --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseClientReferenceInformation.md @@ -0,0 +1,12 @@ +# RiskV1DecisionsPost201ResponseClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | 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** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] +**partner** | [**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/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md new file mode 100644 index 00000000..229470d5 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md @@ -0,0 +1,55 @@ +# RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_token** | **str** | JSON Web Token (JWT) used to authenticate the consumer with the authentication provider, such as, CardinalCommerce or Rupay. Note - Max Length of this field is 2048 characters. | [optional] +**acs_rendering_type** | **str** | Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. | [optional] +**acs_transaction_id** | **str** | Unique transaction identifier assigned by the ACS to identify a single transaction. | [optional] +**acs_url** | **str** | URL for the card-issuing bank's authentication form that you receive when the card is enrolled. The value can be very large. | [optional] +**authentication_path** | **str** | 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] +**authorization_payload** | **str** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional] +**authentication_type** | **str** | 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] +**authentication_transaction_id** | **str** | 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] +**authentication_transaction_context_id** | **str** | Payer authentication transaction identifier passed to link the validation and authorization calls. | [optional] +**validity_period** | **int** | Describes validity of OTP in minutes for incoming transaction. . | [optional] +**cardholder_message** | **str** | 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] +**cavv** | **str** | Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor. | [optional] +**cavv_algorithm** | **str** | Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard | [optional] +**challenge_cancel_code** | **str** | 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] +**challenge_required** | **str** | Indicates whether a challenge is required in order to complete authentication. **Note** Regional mandates might determine that a challenge is required. Possible values: - `Y`: Challenge required - `N`: Challenge not required **Note** Used by the Hybrid integration. | [optional] +**decoupled_authentication_indicator** | **str** | 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] +**directory_server_error_code** | **str** | The directory server error code indicating a problem with this transaction. Note - Max Length of this field is typically 3 characters. | [optional] +**directory_server_error_description** | **str** | Directory server text and additional detail about the error for this transaction. | [optional] +**ecommerce_indicator** | **str** | Commerce indicator for cards not enrolled. This field contains one of these values: - `internet`: Card not enrolled, or card type not supported by payer authentication. No liability shift. - `js_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `js_failure`: J/Secure directory service is not available. No liability shift. - `spa`: Mastercard card not enrolled in the SecureCode program. No liability shift. - `vbv_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `vbv_failure`: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive this result if Visa's directory service is not available. No liability shift. | [optional] +**eci** | **str** | Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see \"Interpreting the Reply,\" page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.) | [optional] +**eci_raw** | **str** | ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of `eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover) | [optional] +**effective_authentication_type** | **str** | This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer). | [optional] +**exemption_data_raw** | **str** | Payer authentication exemption indicator for Carte Bancaire exemptions. This is used with unbundled authentication and authorizations calls, for example: \"low fraud merchant program\". The value returned in this field should be passed in the authorization request under the field - `consumerAuthenticationInformation.strongAuthentication.issuerInformation.exemptionDataRaw`. | [optional] +**ivr** | [**PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr**](PtsV2PaymentsPost201ResponseConsumerAuthenticationInformationIvr.md) | | [optional] +**network_score** | **str** | The global score calculated by the CB scoring platform and returned to merchants. | [optional] +**pareq** | **str** | 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] +**pares_status** | **str** | 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] +**proof_xml** | **str** | 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] +**proxy_pan** | **str** | Encrypted version of the card number used in the payer authentication request message. | [optional] +**sdk_transaction_id** | **str** | SDK unique transaction identifier that is generated on each new transaction. | [optional] +**signed_pares_status_reason** | **str** | Provides additional information as to why the PAResStatus has a specific value. | [optional] +**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 | [optional] +**step_up_url** | **str** | The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration. | [optional] +**three_ds_server_transaction_id** | **str** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] +**ucaf_authentication_data** | **str** | 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] +**ucaf_collection_indicator** | **str** | 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] +**veres_enrolled** | **str** | 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] +**white_list_status_source** | **str** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional] +**xid** | **str** | 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] +**directory_server_transaction_id** | **str** | 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] +**acs_operator_id** | **str** | Directory Server assigned ACS identifier. | [optional] +**acs_reference_number** | **str** | Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval. | [optional] +**idci_decision** | **str** | Decision on the Risk Assessment from Mastercard. | [optional] +**idci_reason_code1** | **str** | ReasonCode from Mastercard | [optional] +**idci_reason_code2** | **str** | ReasonCode from Mastercard | [optional] +**idci_score** | **int** | Risk Assessment from Mastercard | [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/RiskV1DecisionsPost201ResponseErrorInformation.md b/docs/RiskV1DecisionsPost201ResponseErrorInformation.md new file mode 100644 index 00000000..20821dbe --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseErrorInformation.md @@ -0,0 +1,12 @@ +# RiskV1DecisionsPost201ResponseErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | The reason of the status. Possible values: - `EXPIRED_CARD` - `SCORE_EXCEEDS_THRESHOLD` - `DECISION_PROFILE_REVIEW` - `DECISION_PROFILE_REJECT` - `CONSUMER_AUTHENTICATION_REQUIRED` - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_FAILED` - `DECISION_PROFILE_CHALLENGE` - `CUSTOMER_WATCHLIST_MATCH` - `ADDRESS_COUNTRY_WATCHLIST_MATCH` - `EMAIL_COUNTRY_WATCHLIST_MATCH` - `IP_COUNTRY_WATCHLIST_MATCH` | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1DecisionsPost201ResponseOrderInformation.md b/docs/RiskV1DecisionsPost201ResponseOrderInformation.md new file mode 100644 index 00000000..0199dab0 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseOrderInformation.md @@ -0,0 +1,10 @@ +# RiskV1DecisionsPost201ResponseOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_details** | [**RiskV1DecisionsPost201ResponseOrderInformationAmountDetails**](RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.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/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md b/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md new file mode 100644 index 00000000..9ce19e3b --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md @@ -0,0 +1,10 @@ +# RiskV1DecisionsPost201ResponseOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **str** | 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/RiskV1DecisionsPost201ResponsePaymentInformation.md b/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md new file mode 100644 index 00000000..4c32e1b6 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponsePaymentInformation.md @@ -0,0 +1,14 @@ +# RiskV1DecisionsPost201ResponsePaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bin_country** | **str** | 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] +**account_type** | **str** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. | [optional] +**issuer** | **str** | Name of the bank or entity that issued the card account. | [optional] +**scheme** | **str** | 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** | **str** | 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/RiskV1DecisionsPost400Response.md b/docs/RiskV1DecisionsPost400Response.md new file mode 100644 index 00000000..d7295c1d --- /dev/null +++ b/docs/RiskV1DecisionsPost400Response.md @@ -0,0 +1,14 @@ +# RiskV1DecisionsPost400Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - `INVALID_REQUEST` - `DECLINED` | [optional] +**reason** | **str** | The reason of the status. Possible values: - `MISSING_FIELD` - `INVALID_DATA` - `INVALID_ACCOUNT` | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1DecisionsPost400Response1.md b/docs/RiskV1DecisionsPost400Response1.md new file mode 100644 index 00000000..0f46669b --- /dev/null +++ b/docs/RiskV1DecisionsPost400Response1.md @@ -0,0 +1,14 @@ +# RiskV1DecisionsPost400Response1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] +**reason** | **str** | The reason of the status. Possible Values: - `MISSING_FIELD` - `INVALID_DATA` | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1ExportComplianceInquiriesPost201Response.md b/docs/RiskV1ExportComplianceInquiriesPost201Response.md new file mode 100644 index 00000000..194ebac0 --- /dev/null +++ b/docs/RiskV1ExportComplianceInquiriesPost201Response.md @@ -0,0 +1,18 @@ +# RiskV1ExportComplianceInquiriesPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**submit_time_local** | **str** | Time that the transaction was submitted in local time. Generated by Cybersource. | [optional] +**status** | **str** | The status for the call can be: - COMPLETED - INVALID_REQUEST - DECLINED | [optional] +**message** | **str** | The message describing the reason of the status. Value can be - The customer matched the Denied Parties List - The Export bill_country/ship_country match - Export email_country match - Export hostname_country/ip_country match | [optional] +**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] +**export_compliance_information** | [**PtsV2PaymentsPost201ResponseWatchlistScreeningInformation**](PtsV2PaymentsPost201ResponseWatchlistScreeningInformation.md) | | [optional] +**error_information** | [**RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation**](RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.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/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.md b/docs/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.md new file mode 100644 index 00000000..1f2231ef --- /dev/null +++ b/docs/RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation.md @@ -0,0 +1,12 @@ +# RiskV1ExportComplianceInquiriesPost201ResponseErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | The reason of the status. Value can be - `CUSTOMER_WATCHLIST_MATCH` - `ADDRESS_COUNTRY_WATCHLIST_MATCH` - `EMAIL_COUNTRY_WATCHLIST_MATCH` - `IP_COUNTRY_WATCHLIST_MATCH` - `INVALID_MERCHANT_CONFIGURATION` | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/RiskV1UpdatePost201Response.md b/docs/RiskV1UpdatePost201Response.md new file mode 100644 index 00000000..0fc289a8 --- /dev/null +++ b/docs/RiskV1UpdatePost201Response.md @@ -0,0 +1,14 @@ +# RiskV1UpdatePost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] +**client_reference_informaton** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**status** | **str** | The status for risk update 201 calls. Possible values are: - INVALID_REQUEST - COMPLETED | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] + +[[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/Riskv1addressverificationsBuyerInformation.md b/docs/Riskv1addressverificationsBuyerInformation.md new file mode 100644 index 00000000..beddceab --- /dev/null +++ b/docs/Riskv1addressverificationsBuyerInformation.md @@ -0,0 +1,10 @@ +# Riskv1addressverificationsBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_customer_id** | **str** | Optional customer's account ID, tracking number, reward number, or other unique number that you assign to the customer for the purpose that you choose | [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/Riskv1addressverificationsOrderInformation.md b/docs/Riskv1addressverificationsOrderInformation.md new file mode 100644 index 00000000..dd5d536a --- /dev/null +++ b/docs/Riskv1addressverificationsOrderInformation.md @@ -0,0 +1,12 @@ +# Riskv1addressverificationsOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bill_to** | [**Riskv1addressverificationsOrderInformationBillTo**](Riskv1addressverificationsOrderInformationBillTo.md) | | [optional] +**ship_to** | [**Riskv1addressverificationsOrderInformationShipTo**](Riskv1addressverificationsOrderInformationShipTo.md) | | [optional] +**line_items** | [**list[Riskv1addressverificationsOrderInformationLineItems]**](Riskv1addressverificationsOrderInformationLineItems.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/Riskv1addressverificationsOrderInformationBillTo.md b/docs/Riskv1addressverificationsOrderInformationBillTo.md new file mode 100644 index 00000000..6b025561 --- /dev/null +++ b/docs/Riskv1addressverificationsOrderInformationBillTo.md @@ -0,0 +1,17 @@ +# Riskv1addressverificationsOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | 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. | +**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] +**address3** | **str** | Additional address information (third line of the billing address) | [optional] +**address4** | **str** | Additional address information (fourth line of the billing address) | [optional] +**administrative_area** | **str** | 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] +**country** | **str** | 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. | +**locality** | **str** | 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. | +**postal_code** | **str** | 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/Riskv1addressverificationsOrderInformationLineItems.md b/docs/Riskv1addressverificationsOrderInformationLineItems.md new file mode 100644 index 00000000..ea8a5b21 --- /dev/null +++ b/docs/Riskv1addressverificationsOrderInformationLineItems.md @@ -0,0 +1,15 @@ +# Riskv1addressverificationsOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | +**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] +**product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] +**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [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/Riskv1addressverificationsOrderInformationShipTo.md b/docs/Riskv1addressverificationsOrderInformationShipTo.md new file mode 100644 index 00000000..2c2f6136 --- /dev/null +++ b/docs/Riskv1addressverificationsOrderInformationShipTo.md @@ -0,0 +1,17 @@ +# Riskv1addressverificationsOrderInformationShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | +**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address3** | **str** | Third line of the shipping address. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address4** | **str** | Fourth line of the shipping address. | [optional] +**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | +**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [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/Riskv1authenticationresultsConsumerAuthenticationInformation.md b/docs/Riskv1authenticationresultsConsumerAuthenticationInformation.md new file mode 100644 index 00000000..b6f0624f --- /dev/null +++ b/docs/Riskv1authenticationresultsConsumerAuthenticationInformation.md @@ -0,0 +1,17 @@ +# Riskv1authenticationresultsConsumerAuthenticationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authentication_transaction_id** | **str** | 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. | +**authentication_transaction_context** | **str** | Authentication transaction context is used as a unique identifier to link enroll and validate call. | [optional] +**otp_token** | **str** | OTP entered by the card holder. | [optional] +**response_access_token** | **str** | JWT returned by the 3D Secure provider when the authentication is complete. Required for Hybrid integration if you use the Cybersource-generated access token. Note: Max. length of this field is 2048 characters. | [optional] +**signed_pares_status_reason** | **str** | Provides additional information as to why the PAResStatus has a specific value. | [optional] +**signed_pares** | **str** | Payer authentication result (PARes) message returned by the card-issuing bank. If you need to show proof of enrollment checking, you may need to decrypt and parse the string for the information required by the payment card company. For more information, see \"Storing Payer Authentication Data,\" page 160. Important The value is in base64. You must remove all carriage returns and line feeds before adding the PARes to the request. | [optional] +**white_list_status** | **str** | Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder | [optional] +**credential_encrypted** | **str** | A flag to indicate if the passed credential has been encrypted by the Merchant. | [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/Riskv1authenticationresultsDeviceInformation.md b/docs/Riskv1authenticationresultsDeviceInformation.md new file mode 100644 index 00000000..ecd34e74 --- /dev/null +++ b/docs/Riskv1authenticationresultsDeviceInformation.md @@ -0,0 +1,10 @@ +# Riskv1authenticationresultsDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** 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/Riskv1authenticationresultsOrderInformation.md b/docs/Riskv1authenticationresultsOrderInformation.md new file mode 100644 index 00000000..11468d96 --- /dev/null +++ b/docs/Riskv1authenticationresultsOrderInformation.md @@ -0,0 +1,10 @@ +# Riskv1authenticationresultsOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_details** | [**Riskv1authenticationresultsOrderInformationAmountDetails**](Riskv1authenticationresultsOrderInformationAmountDetails.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/Riskv1authenticationresultsOrderInformationAmountDetails.md b/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md new file mode 100644 index 00000000..eeafb88a --- /dev/null +++ b/docs/Riskv1authenticationresultsOrderInformationAmountDetails.md @@ -0,0 +1,11 @@ +# Riskv1authenticationresultsOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **str** | 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] +**total_amount** | **str** | 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 / Pay By Link Required for creating a new invoice or payment link. #### 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/Riskv1authenticationresultsPaymentInformation.md b/docs/Riskv1authenticationresultsPaymentInformation.md new file mode 100644 index 00000000..7d22260d --- /dev/null +++ b/docs/Riskv1authenticationresultsPaymentInformation.md @@ -0,0 +1,13 @@ +# Riskv1authenticationresultsPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**Riskv1authenticationresultsPaymentInformationCard**](Riskv1authenticationresultsPaymentInformationCard.md) | | [optional] +**tokenized_card** | [**Riskv1authenticationresultsPaymentInformationTokenizedCard**](Riskv1authenticationresultsPaymentInformationTokenizedCard.md) | | [optional] +**fluid_data** | [**Riskv1authenticationresultsPaymentInformationFluidData**](Riskv1authenticationresultsPaymentInformationFluidData.md) | | [optional] +**customer** | [**Riskv1authenticationsPaymentInformationCustomer**](Riskv1authenticationsPaymentInformationCustomer.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/Riskv1authenticationresultsPaymentInformationCard.md b/docs/Riskv1authenticationresultsPaymentInformationCard.md new file mode 100644 index 00000000..0a039060 --- /dev/null +++ b/docs/Riskv1authenticationresultsPaymentInformationCard.md @@ -0,0 +1,13 @@ +# Riskv1authenticationresultsPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] +**expiration_year** | **str** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] +**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [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/Riskv1authenticationresultsPaymentInformationFluidData.md b/docs/Riskv1authenticationresultsPaymentInformationFluidData.md new file mode 100644 index 00000000..d4250982 --- /dev/null +++ b/docs/Riskv1authenticationresultsPaymentInformationFluidData.md @@ -0,0 +1,13 @@ +# Riskv1authenticationresultsPaymentInformationFluidData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution used by the merchant. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits that use a Cybersource suppored Point-to-Point encryption method. Card Present processing This field represents the encrypted payment data generated by the payment terminal/device. | [optional] +**key_serial_number** | **str** | The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) | [optional] +**descriptor** | **str** | The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is `Ymx1ZWZpbg==`. paymentInformation.fluidData.encoding must be `Base64`. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is `Base64`, the value is: `RklEPUVNVi5QQVlNRU5ULkFQSQ==` If paymentInformation.fluidData.encoding is `HEX`, the value is: `4649443D454D562E5041594D454E542E41504` | [optional] +**encoding** | **str** | Encoding method used to encrypt the payment data. Valid values: `Base64`, `HEX` If no value is provided, `Base64` is taken as the default value. And the `Base64` descriptor is used for paymentInformation.fluidData.encoding | [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/Riskv1authenticationresultsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md new file mode 100644 index 00000000..c784fc1c --- /dev/null +++ b/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md @@ -0,0 +1,14 @@ +# Riskv1authenticationresultsPaymentInformationTokenizedCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | [optional] +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**number** | **str** | Customer's payment network token value. | [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/Riskv1authenticationsBuyerInformation.md b/docs/Riskv1authenticationsBuyerInformation.md new file mode 100644 index 00000000..f7be07fe --- /dev/null +++ b/docs/Riskv1authenticationsBuyerInformation.md @@ -0,0 +1,13 @@ +# Riskv1authenticationsBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_customer_id** | **str** | 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] +**personal_identification** | [**list[Ptsv2paymentsBuyerInformationPersonalIdentification]**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | This array contains detailed information about the buyer's form of persoanl identification. | [optional] +**mobile_phone** | **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. | +**work_phone** | **int** | Cardholder's work phone number. | [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/Riskv1authenticationsDeviceInformation.md b/docs/Riskv1authenticationsDeviceInformation.md new file mode 100644 index 00000000..b34d6f58 --- /dev/null +++ b/docs/Riskv1authenticationsDeviceInformation.md @@ -0,0 +1,21 @@ +# Riskv1authenticationsDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] +**raw_data** | [**list[Ptsv2paymentsDeviceInformationRawData]**](Ptsv2paymentsDeviceInformationRawData.md) | | [optional] +**http_accept_browser_value** | **str** | Value of the Accept header sent by the customer's web browser. **Note** If the customer's browser provides a value, you must include it in your request. | [optional] +**http_accept_content** | **str** | The exact content of the HTTP accept header. | +**http_browser_language** | **str** | Value represents the browser language as defined in IETF BCP47. Example:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details. | +**http_browser_java_enabled** | **bool** | A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False | +**http_browser_java_script_enabled** | **bool** | A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. **Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser. | [optional] +**http_browser_color_depth** | **str** | Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details | +**http_browser_screen_height** | **str** | Total height of the Cardholder's scree in pixels, example: 864. | +**http_browser_screen_width** | **str** | Total width of the cardholder's screen in pixels. Example: 1536. | +**http_browser_time_difference** | **str** | Time difference between UTC time and the cardholder browser local time, in minutes, Example:300 | +**user_agent_browser_value** | **str** | Value of the User-Agent header sent by the customer's web browser. Note If the customer's browser provides a value, you must include it in your request. | + +[[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/Riskv1authenticationsOrderInformation.md b/docs/Riskv1authenticationsOrderInformation.md new file mode 100644 index 00000000..2d0f45d3 --- /dev/null +++ b/docs/Riskv1authenticationsOrderInformation.md @@ -0,0 +1,17 @@ +# Riskv1authenticationsOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_details** | [**Riskv1authenticationsOrderInformationAmountDetails**](Riskv1authenticationsOrderInformationAmountDetails.md) | | [optional] +**pre_order** | **str** | Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability | [optional] +**pre_order_date** | **str** | Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD | [optional] +**reordered** | **bool** | Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered | [optional] +**ship_to** | [**Riskv1decisionsOrderInformationShipTo**](Riskv1decisionsOrderInformationShipTo.md) | | [optional] +**line_items** | [**list[Riskv1authenticationsOrderInformationLineItems]**](Riskv1authenticationsOrderInformationLineItems.md) | This array contains detailed information about individual products in the order. | [optional] +**bill_to** | [**Riskv1authenticationsOrderInformationBillTo**](Riskv1authenticationsOrderInformationBillTo.md) | | [optional] +**total_offers_count** | **str** | Total number of articles/items in the order as a numeric decimal count. Possible values: 00 - 99 | [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/Riskv1authenticationsOrderInformationAmountDetails.md b/docs/Riskv1authenticationsOrderInformationAmountDetails.md new file mode 100644 index 00000000..1e1033d9 --- /dev/null +++ b/docs/Riskv1authenticationsOrderInformationAmountDetails.md @@ -0,0 +1,11 @@ +# Riskv1authenticationsOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **str** | 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. | +**total_amount** | **str** | 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 / Pay By Link Required for creating a new invoice or payment link. #### 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/Riskv1authenticationsOrderInformationBillTo.md b/docs/Riskv1authenticationsOrderInformationBillTo.md new file mode 100644 index 00000000..5b153e9e --- /dev/null +++ b/docs/Riskv1authenticationsOrderInformationBillTo.md @@ -0,0 +1,20 @@ +# Riskv1authenticationsOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | 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. | +**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] +**address3** | **str** | Additional address information (third line of the billing address) | [optional] +**administrative_area** | **str** | 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. | +**country** | **str** | 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. | +**locality** | **str** | 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] +**first_name** | **str** | 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. | +**last_name** | **str** | 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. | +**phone_number** | **str** | 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** | **str** | 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. | +**postal_code** | **str** | 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/Riskv1authenticationsOrderInformationLineItems.md b/docs/Riskv1authenticationsOrderInformationLineItems.md new file mode 100644 index 00000000..cfc377dd --- /dev/null +++ b/docs/Riskv1authenticationsOrderInformationLineItems.md @@ -0,0 +1,29 @@ +# Riskv1authenticationsOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | +**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] +**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] +**product_description** | **str** | Brief description of item. | [optional] +**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**passenger** | [**Ptsv2paymentsOrderInformationPassenger**](Ptsv2paymentsOrderInformationPassenger.md) | | [optional] +**shipping_destination_types** | **str** | Destination to where the item will be shipped. Example: Commercial, Residential, Store | [optional] +**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] +**shipping_address1** | **str** | Address where item will be shipped | [optional] +**shipping_address2** | **str** | Address where item will be shipped | [optional] +**shipping_city** | **str** | City where item will be shipped | [optional] +**shipping_country_code** | **str** | Country where item will be shipped | [optional] +**shipping_first_name** | **str** | Customer's first name | [optional] +**shipping_last_name** | **str** | Customer's last name | [optional] +**shipping_middle_name** | **str** | Customer's middle name | [optional] +**shipping_phone** | **int** | Phone number where item will be shipped | [optional] +**shipping_postal_code** | **int** | Postal code where item will be shipped | [optional] +**shipping_state** | **str** | State where item will be shipped | [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/Riskv1authenticationsPaymentInformation.md b/docs/Riskv1authenticationsPaymentInformation.md new file mode 100644 index 00000000..dad1e13b --- /dev/null +++ b/docs/Riskv1authenticationsPaymentInformation.md @@ -0,0 +1,13 @@ +# Riskv1authenticationsPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**Riskv1authenticationsetupsPaymentInformationCard**](Riskv1authenticationsetupsPaymentInformationCard.md) | | [optional] +**tokenized_card** | [**Riskv1authenticationsPaymentInformationTokenizedCard**](Riskv1authenticationsPaymentInformationTokenizedCard.md) | | [optional] +**fluid_data** | [**Riskv1authenticationsetupsPaymentInformationFluidData**](Riskv1authenticationsetupsPaymentInformationFluidData.md) | | [optional] +**customer** | [**Riskv1authenticationsPaymentInformationCustomer**](Riskv1authenticationsPaymentInformationCustomer.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/Riskv1authenticationsPaymentInformationCustomer.md b/docs/Riskv1authenticationsPaymentInformationCustomer.md new file mode 100644 index 00000000..ac2fe58e --- /dev/null +++ b/docs/Riskv1authenticationsPaymentInformationCustomer.md @@ -0,0 +1,11 @@ +# Riskv1authenticationsPaymentInformationCustomer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer_id** | **str** | Unique identifier for the legacy Secure Storage 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. | +**id** | **str** | 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/Riskv1authenticationsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md new file mode 100644 index 00000000..fa7fc2ab --- /dev/null +++ b/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md @@ -0,0 +1,16 @@ +# Riskv1authenticationsPaymentInformationTokenizedCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | +**cryptogram** | **str** | This field contains token information. | +**security_code** | **str** | Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. | +**number** | **str** | Customer's payment network token value. | + +[[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/Riskv1authenticationsRiskInformation.md b/docs/Riskv1authenticationsRiskInformation.md new file mode 100644 index 00000000..4db45839 --- /dev/null +++ b/docs/Riskv1authenticationsRiskInformation.md @@ -0,0 +1,10 @@ +# Riskv1authenticationsRiskInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**buyer_history** | [**Ptsv2paymentsRiskInformationBuyerHistory**](Ptsv2paymentsRiskInformationBuyerHistory.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/Riskv1authenticationsTravelInformation.md b/docs/Riskv1authenticationsTravelInformation.md new file mode 100644 index 00000000..82cb47fb --- /dev/null +++ b/docs/Riskv1authenticationsTravelInformation.md @@ -0,0 +1,12 @@ +# Riskv1authenticationsTravelInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**legs** | [**list[Riskv1decisionsTravelInformationLegs]**](Riskv1decisionsTravelInformationLegs.md) | | [optional] +**number_of_passengers** | **int** | Number of passengers for whom the ticket was issued. If you do not include this field in your request, CyberSource uses a default value of 1. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] +**passengers** | [**list[Riskv1decisionsTravelInformationPassengers]**](Riskv1decisionsTravelInformationPassengers.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/Riskv1authenticationsetupsClientReferenceInformation.md b/docs/Riskv1authenticationsetupsClientReferenceInformation.md new file mode 100644 index 00000000..2d98c603 --- /dev/null +++ b/docs/Riskv1authenticationsetupsClientReferenceInformation.md @@ -0,0 +1,13 @@ +# Riskv1authenticationsetupsClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | 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] +**paused_request_id** | **str** | 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** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] +**partner** | [**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/Riskv1authenticationsetupsPaymentInformation.md b/docs/Riskv1authenticationsetupsPaymentInformation.md new file mode 100644 index 00000000..5f9e58e8 --- /dev/null +++ b/docs/Riskv1authenticationsetupsPaymentInformation.md @@ -0,0 +1,13 @@ +# Riskv1authenticationsetupsPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**Riskv1authenticationsetupsPaymentInformationCard**](Riskv1authenticationsetupsPaymentInformationCard.md) | | [optional] +**tokenized_card** | [**Riskv1authenticationsetupsPaymentInformationTokenizedCard**](Riskv1authenticationsetupsPaymentInformationTokenizedCard.md) | | [optional] +**fluid_data** | [**Riskv1authenticationsetupsPaymentInformationFluidData**](Riskv1authenticationsetupsPaymentInformationFluidData.md) | | [optional] +**customer** | [**Riskv1authenticationsetupsPaymentInformationCustomer**](Riskv1authenticationsetupsPaymentInformationCustomer.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/Riskv1authenticationsetupsPaymentInformationCard.md b/docs/Riskv1authenticationsetupsPaymentInformationCard.md new file mode 100644 index 00000000..2e803e08 --- /dev/null +++ b/docs/Riskv1authenticationsetupsPaymentInformationCard.md @@ -0,0 +1,13 @@ +# Riskv1authenticationsetupsPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | +**expiration_year** | **str** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | +**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | + +[[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/Riskv1authenticationsetupsPaymentInformationCustomer.md b/docs/Riskv1authenticationsetupsPaymentInformationCustomer.md new file mode 100644 index 00000000..e87c1e1e --- /dev/null +++ b/docs/Riskv1authenticationsetupsPaymentInformationCustomer.md @@ -0,0 +1,10 @@ +# Riskv1authenticationsetupsPaymentInformationCustomer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer_id** | **str** | Unique identifier for the legacy Secure Storage 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. | + +[[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/Riskv1authenticationsetupsPaymentInformationFluidData.md b/docs/Riskv1authenticationsetupsPaymentInformationFluidData.md new file mode 100644 index 00000000..46ec1367 --- /dev/null +++ b/docs/Riskv1authenticationsetupsPaymentInformationFluidData.md @@ -0,0 +1,13 @@ +# Riskv1authenticationsetupsPaymentInformationFluidData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution used by the merchant. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits that use a Cybersource suppored Point-to-Point encryption method. Card Present processing This field represents the encrypted payment data generated by the payment terminal/device. | +**key_serial_number** | **str** | The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) | [optional] +**descriptor** | **str** | The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is `Ymx1ZWZpbg==`. paymentInformation.fluidData.encoding must be `Base64`. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is `Base64`, the value is: `RklEPUVNVi5QQVlNRU5ULkFQSQ==` If paymentInformation.fluidData.encoding is `HEX`, the value is: `4649443D454D562E5041594D454E542E41504` | [optional] +**encoding** | **str** | Encoding method used to encrypt the payment data. Valid values: `Base64`, `HEX` If no value is provided, `Base64` is taken as the default value. And the `Base64` descriptor is used for paymentInformation.fluidData.encoding | [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/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md new file mode 100644 index 00000000..8f3b7ae6 --- /dev/null +++ b/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md @@ -0,0 +1,14 @@ +# Riskv1authenticationsetupsPaymentInformationTokenizedCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | +**number** | **str** | Customer's payment network token value. | + +[[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/Riskv1authenticationsetupsProcessingInformation.md b/docs/Riskv1authenticationsetupsProcessingInformation.md new file mode 100644 index 00000000..20c84a1a --- /dev/null +++ b/docs/Riskv1authenticationsetupsProcessingInformation.md @@ -0,0 +1,11 @@ +# Riskv1authenticationsetupsProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**visa_checkout_id** | **str** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** 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/Riskv1authenticationsetupsTokenInformation.md b/docs/Riskv1authenticationsetupsTokenInformation.md new file mode 100644 index 00000000..9fbd71bb --- /dev/null +++ b/docs/Riskv1authenticationsetupsTokenInformation.md @@ -0,0 +1,11 @@ +# Riskv1authenticationsetupsTokenInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transient_token** | **str** | A temporary ID that represents the customer's payment data (which is securely stored in Visa Data Centers). Flex Microform generates this ID and sets it to expire within 15 minutes from when the ID is generated or until the first payment authorization is carried out (whichever occurs first). Valid value for the ID is a 64-character, alphanumeric string. Example: 1D08M4YB968R1F7YVL4TBBKYVNRIR02VZFH9CBYSQIJJXORPI1NK5C98D7F6EB53 | [optional] +**jti** | **str** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [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/Riskv1decisionsAcquirerInformation.md b/docs/Riskv1decisionsAcquirerInformation.md new file mode 100644 index 00000000..1f792aa0 --- /dev/null +++ b/docs/Riskv1decisionsAcquirerInformation.md @@ -0,0 +1,13 @@ +# Riskv1decisionsAcquirerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acquirer_bin** | **str** | Acquirer bank ID number that corresponds to a certificate that Cybersource already has.This ID has this format. 4XXXXX for Visa and 5XXXXX for Mastercard. | [optional] +**country** | **str** | Issuers need to be aware of the Acquirer's Country Code when the Acquirer country differs from the Merchant country and the Acquirer is in the EEA (European Economic Area). | [optional] +**password** | **str** | Registered password for the Visa directory server. | [optional] +**merchant_id** | **str** | Username for the visa directory server that is created when your acquirer sets up your account. This ID might be the same as your merchant ID. the username can be 15 or 23 characters. | [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/Riskv1decisionsBuyerInformation.md b/docs/Riskv1decisionsBuyerInformation.md new file mode 100644 index 00000000..305597d0 --- /dev/null +++ b/docs/Riskv1decisionsBuyerInformation.md @@ -0,0 +1,14 @@ +# Riskv1decisionsBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_customer_id** | **str** | 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** | **str** | Specifies the customer account user name. | [optional] +**hashed_password** | **str** | The merchant's password that CyberSource hashes and stores as a hashed password. | [optional] +**date_of_birth** | **str** | 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] +**personal_identification** | [**list[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/Riskv1decisionsClientReferenceInformation.md b/docs/Riskv1decisionsClientReferenceInformation.md new file mode 100644 index 00000000..cbf1ad29 --- /dev/null +++ b/docs/Riskv1decisionsClientReferenceInformation.md @@ -0,0 +1,13 @@ +# Riskv1decisionsClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | 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. | +**paused_request_id** | **str** | 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** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] +**partner** | [**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/Riskv1decisionsClientReferenceInformationPartner.md b/docs/Riskv1decisionsClientReferenceInformationPartner.md new file mode 100644 index 00000000..d5cf9265 --- /dev/null +++ b/docs/Riskv1decisionsClientReferenceInformationPartner.md @@ -0,0 +1,11 @@ +# Riskv1decisionsClientReferenceInformationPartner + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**developer_id** | **str** | Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. | [optional] +**solution_id** | **str** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [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/Riskv1decisionsConsumerAuthenticationInformation.md b/docs/Riskv1decisionsConsumerAuthenticationInformation.md new file mode 100644 index 00000000..33496496 --- /dev/null +++ b/docs/Riskv1decisionsConsumerAuthenticationInformation.md @@ -0,0 +1,49 @@ +# Riskv1decisionsConsumerAuthenticationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**strong_authentication** | [**Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication**](Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md) | | [optional] +**acs_window_size** | **str** | An override field that a merchant can pass in to set the challenge window size to display to the end cardholder. The ACS (Active Control Server) will reply with content that is formatted appropriately to this window size to allow for the best user experience. The sizes are width x height in pixels of the window displayed in the cardholder browser window. 01 - 250x400 02 - 390x400 03 - 500x600 04 - 600x400 05 - Full page | [optional] +**alternate_authentication_data** | **str** | Data that documents and supports a specific authentication process. | [optional] +**alternate_authentication_date** | **str** | Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM | [optional] +**alternate_authentication_method** | **str** | Mechanism used by the cardholder to authenticate to the 3D Secure requestor. Possible values: - `01`: No authentication occurred - `02`: Login using merchant system credentials - `03`: Login using Federated ID - `04`: Login using issuer credentials - `05`: Login using third-party authenticator - `06`: Login using FIDO Authenticator | [optional] +**authentication_date** | **str** | 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] +**authentication_transaction_id** | **str** | 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] +**transaction_flow_indicator** | **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] +**challenge_code** | **str** | 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] +**challenge_status** | **str** | 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] +**customer_card_alias** | **str** | 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] +**decoupled_authentication_indicator** | **str** | 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] +**decoupled_authentication_max_time** | **str** | Indicates the maximum amount of time that the 3DS Requestor will wait for an ACS (Active control server) to provide the results of a Decoupled Authentication transaction (in minutes). Possible Values: Numeric values between 1 and 10080 accepted. | [optional] +**default_card** | **bool** | Indicates that the card being used is the one designated as the primary payment card for purchase. Recommended for Discover ProtectBuy. | [optional] +**device_channel** | **str** | Determines the channel that the transaction came through. Possible Values: SDK/Browser/3RI. 3RI - 3DS request initiated. | +**installment_total_count** | **int** | An integer value greater than 1 indicating the max number of permitted authorizations for installment payments. **Note** This is required if the merchant and cardholder have agreed to installment payments. | [optional] +**merchant_fraud_rate** | **str** | Calculated by merchants as per PSD2** RTS** (EEA** card fraud divided by all EEA card volumes). Possible Values: 1 = Represents fraud rate <=1 2 = Represents fraud rate >1 and <=6 3 = Represents fraud rate >6 and <=13 4 = Represents fraud rate >13 and <=25 5 = Represents fraud rate >25 EEA** = European Economic Area RTS** = Regulatory Technical Standards PSD2** = Payment Services Directive | [optional] +**marketing_opt_in** | **bool** | Indicates whether the customer has opted in for marketing offers. Recommended for Discover ProtectBuy. | [optional] +**marketing_source** | **str** | Indicates origin of the marketing offer. Recommended for Discover ProtectBuy. | [optional] +**mcc** | **str** | Merchant category code. **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. | [optional] +**merchant_score** | **int** | Risk Score provided by merchants. This is specific for CB transactions. | [optional] +**message_category** | **str** | Category of the message for a specific use case. Possible values: - `01`: PA- payment authentication - `02`: NPA- non-payment authentication - `03-79`: Reserved for EMVCo future use (values invalid until defined by EMVCo) - `80-99`: Reserved for DS use | [optional] +**npa_code** | **str** | Non-Payer Authentication Indicator. Possible values: - `01`: Add card - `02`: Maintain card information - `03`: Cardholder verification for EMV token - `04-80` Reserved for EMVCo - `80-90` Reserved DS | [optional] +**override_payment_method** | **str** | Specifies the Brazilian payment account type used for the transaction. This field overrides other payment types that might be specified in the request. Use one of the following values for this field: - `NA`: Not applicable. Do not override other payment types that are specified in the request. - `CR`: Credit card. - `DB`: Debit card. - `VSAVR`: Visa Vale Refeicao - `VSAVA`: Visa Vale Alimentacao **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. | [optional] +**override_country_code** | **str** | Two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).. | [optional] +**prior_authentication_data** | **str** | This field carry data that the ACS can use to verify the authentication process. | [optional] +**prior_authentication_method** | **str** | Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. 01 - Frictionless authentication occurred by ACS 02 - Cardholder challenge occurred by ACS 03 - AVS verified 04 - Other issuer methods 05-79 - Reserved for EMVCo future use (values invalid until defined by EMVCo) 80-99 - Reserved for DS use | [optional] +**prior_authentication_reference_id** | **str** | This data element contains a ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder | [optional] +**prior_authentication_time** | **str** | Date and time in UTC of the prior cardholder authentication. Format – YYYYMMDDHHMM | [optional] +**product_code** | **str** | Specifies the product code, which designates the type of transaction. Specify one of the following values for this field: - AIR: Airline purchase Important Required for American Express SafeKey (U.S.). - `ACC`: Accommodation Rental - `ACF`: Account funding - `CHA`: Check acceptance - `DIG`: Digital Goods - `DSP`: Cash Dispensing - `GAS`: Fuel - `GEN`: General Retail - `LUX`: Luxury Retail - `PAL`: Prepaid activation and load - `PHY`: Goods or services purchase - `QCT`: Quasi-cash transaction - `REN`: Car Rental - `RES`: Restaurant - `SVC`: Services - `TBD`: Other - `TRA`: Travel **Important** Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. | [optional] +**return_url** | **str** | The URL of the merchant's return page. CyberSource adds this return URL to the step-up JWT and returns it in the response of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL. Once the bank session completes, the merchant receives a POST to their URL. This response contains the completed bank session's transactionId. The merchant's return page should capture the transaction ID and send it in the Payer Authentication validation call. | [optional] +**requestor_id** | **str** | Cardinal's directory server assigned 3DS Requestor ID value | [optional] +**requestor_initiated_authentication_indicator** | **str** | Indicates the type of 3RI request. Possible Values: 01 - Recurring transaction 02 - Installment transaction 03 - Add card 04 - Maintain card 05 - Account verification 06 - Split/delayed shipment 07 - Top-up 08 - Mail Order 09 - Telephone Order 10 - Whitelist status check 11 - Other payment | [optional] +**requestor_name** | **str** | Cardinal's directory server assigned 3DS Requestor Name value | [optional] +**reference_id** | **str** | Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration. | [optional] +**sdk_max_timeout** | **str** | This field indicates the maximum amount of time for all 3DS 2.0 messages to be communicated between all components (in minutes). Possible Values: Greater than or equal to 05 (05 is the minimum timeout to set) Cardinal Default is set to 15 NOTE: This field is a required 3DS 2.0 field and Cardinal sends in a default of 15 if nothing is passed | [optional] +**secure_corporate_payment_indicator** | **str** | Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies. Possible Values : 0/1 | [optional] +**transaction_mode** | **str** | Transaction mode identifier. Identifies the channel from which the transaction originates. Possible values: - `M`: MOTO (Mail Order Telephone Order) - `R`: Retail - `S`: eCommerce - `P`: Mobile Device - `T`: Tablet | [optional] +**white_list_status** | **str** | Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder | [optional] +**score_request** | **int** | Risk Assessment from Mastercard. This is to be sent by merchant if they would like to request a score | [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/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md b/docs/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md new file mode 100644 index 00000000..2046768d --- /dev/null +++ b/docs/Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication.md @@ -0,0 +1,10 @@ +# Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authentication_indicator** | **str** | Indicates the type of Authentication request 01 - Payment transaction 02 - Recurring transaction 03 - Installment transaction 04 - Add card 05 - Maintain card 06 - Cardholder verification as part of EMV token ID and V | [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/Riskv1decisionsDeviceInformation.md b/docs/Riskv1decisionsDeviceInformation.md new file mode 100644 index 00000000..09ab6a40 --- /dev/null +++ b/docs/Riskv1decisionsDeviceInformation.md @@ -0,0 +1,26 @@ +# Riskv1decisionsDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cookies_accepted** | **str** | Whether the customer's browser accepts cookies. This field can contain one of the following values: - `yes`: The customer's browser accepts cookies. - `no`: The customer's browser does not accept cookies. | [optional] +**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] +**host_name** | **str** | DNS resolved hostname from `ipAddress`. | [optional] +**fingerprint_session_id** | **str** | Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID. The session ID must be unique for each page load, regardless of an individual's web session ID. If a user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. You may use a web session ID, but it is preferable to use an application GUID (Globally Unique Identifier). This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page. | [optional] +**http_browser_email** | **str** | Email address set in the customer's browser, which may differ from customer email. | [optional] +**user_agent** | **str** | Customer's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser. | [optional] +**raw_data** | [**list[Ptsv2paymentsDeviceInformationRawData]**](Ptsv2paymentsDeviceInformationRawData.md) | | [optional] +**http_accept_browser_value** | **str** | Value of the Accept header sent by the customer's web browser. **Note** If the customer's browser provides a value, you must include it in your request. | [optional] +**http_accept_content** | **str** | The exact content of the HTTP accept header. | [optional] +**http_browser_language** | **str** | Value represents the browser language as defined in IETF BCP47. Example:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details. | [optional] +**http_browser_java_enabled** | **bool** | A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False | [optional] +**http_browser_java_script_enabled** | **bool** | A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. **Note**: Merchants should be able to know the values from fingerprint details of cardholder's browser. | [optional] +**http_browser_color_depth** | **str** | Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details | [optional] +**http_browser_screen_height** | **str** | Total height of the Cardholder's scree in pixels, example: 864. | [optional] +**http_browser_screen_width** | **str** | Total width of the cardholder's screen in pixels. Example: 1536. | [optional] +**http_browser_time_difference** | **str** | Time difference between UTC time and the cardholder browser local time, in minutes, Example:300 | [optional] +**user_agent_browser_value** | **str** | Value of the User-Agent header sent by the customer's web browser. Note If the customer's browser provides a value, you must include it in your request. | [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/Riskv1decisionsMerchantDefinedInformation.md b/docs/Riskv1decisionsMerchantDefinedInformation.md new file mode 100644 index 00000000..076a652e --- /dev/null +++ b/docs/Riskv1decisionsMerchantDefinedInformation.md @@ -0,0 +1,11 @@ +# Riskv1decisionsMerchantDefinedInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Fields that you can use to store information. The value appears in the Case Management Details window in the Business Center. The first four fields are the same fields that are used by the Secure Data services. See request code examples. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. | [optional] +**value** | **str** | String value for the key | [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/Riskv1decisionsMerchantInformation.md b/docs/Riskv1decisionsMerchantInformation.md new file mode 100644 index 00000000..9878f9cb --- /dev/null +++ b/docs/Riskv1decisionsMerchantInformation.md @@ -0,0 +1,11 @@ +# Riskv1decisionsMerchantInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_descriptor** | [**Riskv1decisionsMerchantInformationMerchantDescriptor**](Riskv1decisionsMerchantInformationMerchantDescriptor.md) | | [optional] +**merchant_name** | **str** | Your company's name as you want it to appear to the customer in the issuing bank's authentication form. This value overrides the value specified by your merchant bank. | [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/Riskv1decisionsMerchantInformationMerchantDescriptor.md b/docs/Riskv1decisionsMerchantInformationMerchantDescriptor.md new file mode 100644 index 00000000..9a4d79c8 --- /dev/null +++ b/docs/Riskv1decisionsMerchantInformationMerchantDescriptor.md @@ -0,0 +1,11 @@ +# Riskv1decisionsMerchantInformationMerchantDescriptor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. **Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. **Important** This value must consist of English characters. Required for captures and credits. | [optional] +**url** | **str** | Address of company's website provided by merchant | [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/Riskv1decisionsOrderInformation.md b/docs/Riskv1decisionsOrderInformation.md new file mode 100644 index 00000000..dbe2996c --- /dev/null +++ b/docs/Riskv1decisionsOrderInformation.md @@ -0,0 +1,20 @@ +# Riskv1decisionsOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_details** | [**Riskv1decisionsOrderInformationAmountDetails**](Riskv1decisionsOrderInformationAmountDetails.md) | | [optional] +**pre_order** | **str** | Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability | [optional] +**pre_order_date** | **str** | Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD | [optional] +**cutoff_date_time** | **str** | Starting date and time for an event or a journey that is independent of which transportation mechanism, in UTC. The cutoffDateTime will supersede travelInformation.departureTime if both are supplied in the request. 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] +**reordered** | **bool** | Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered | [optional] +**shipping_details** | [**Riskv1decisionsOrderInformationShippingDetails**](Riskv1decisionsOrderInformationShippingDetails.md) | | [optional] +**ship_to** | [**Riskv1decisionsOrderInformationShipTo**](Riskv1decisionsOrderInformationShipTo.md) | | [optional] +**returns_accepted** | **bool** | Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - true: Returns are accepted for this order. - false: Returns are not accepted for this order. | [optional] +**line_items** | [**list[Riskv1decisionsOrderInformationLineItems]**](Riskv1decisionsOrderInformationLineItems.md) | This array contains detailed information about individual products in the order. | [optional] +**bill_to** | [**Riskv1decisionsOrderInformationBillTo**](Riskv1decisionsOrderInformationBillTo.md) | | [optional] +**total_offers_count** | **str** | Total number of articles/items in the order as a numeric decimal count. Possible values: 00 - 99 | [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/Riskv1decisionsOrderInformationAmountDetails.md b/docs/Riskv1decisionsOrderInformationAmountDetails.md new file mode 100644 index 00000000..5e24ad10 --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationAmountDetails.md @@ -0,0 +1,11 @@ +# Riskv1decisionsOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **str** | 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. | +**total_amount** | **str** | 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. 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. 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 [REST API Fields Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) #### DCC for First Data Not used. For details, see [REST API Field Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) | [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/Riskv1decisionsOrderInformationBillTo.md b/docs/Riskv1decisionsOrderInformationBillTo.md new file mode 100644 index 00000000..22315330 --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationBillTo.md @@ -0,0 +1,19 @@ +# Riskv1decisionsOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | 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] +**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] +**administrative_area** | **str** | 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] +**country** | **str** | 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] +**locality** | **str** | 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] +**first_name** | **str** | 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] +**last_name** | **str** | 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] +**phone_number** | **str** | 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** | **str** | 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] +**postal_code** | **str** | 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/Riskv1decisionsOrderInformationLineItems.md b/docs/Riskv1decisionsOrderInformationLineItems.md new file mode 100644 index 00000000..5aacf8fa --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationLineItems.md @@ -0,0 +1,25 @@ +# Riskv1decisionsOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] +**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] +**product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] +**product_description** | **str** | Brief description of item. | [optional] +**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**gift** | **bool** | This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different. | [optional] +**distributor_product_sku** | **str** | Product's identifier code. This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer) in the list of API fields with which you can create custom rules. | [optional] +**passenger** | [**Ptsv2paymentsOrderInformationPassenger**](Ptsv2paymentsOrderInformationPassenger.md) | | [optional] +**shipping_destination_types** | **str** | Destination to where the item will be shipped. Example: Commercial, Residential, Store | [optional] +**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] +**allowed_export_countries** | **list[str]** | | [optional] +**restricted_export_countries** | **list[str]** | | [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/Riskv1decisionsOrderInformationShipTo.md b/docs/Riskv1decisionsOrderInformationShipTo.md new file mode 100644 index 00000000..0d5ae7a6 --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationShipTo.md @@ -0,0 +1,23 @@ +# Riskv1decisionsOrderInformationShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address3** | **str** | Third line of the shipping address. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**destination_types** | **str** | Shipping destination of item. Example: Commercial, Residential, Store | [optional] +**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] +**last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] +**middle_name** | **str** | Middle name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] +**phone_number** | **str** | Phone number associated with the shipping address. | [optional] +**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**destination_code** | **int** | Indicates destination chosen for the transaction. Possible values: - 01- Ship to cardholder billing address - 02- Ship to another verified address on file with merchant - 03- Ship to address that is different than billing address - 04- Ship to store (store address should be populated on request) - 05- Digital goods - 06- Travel and event tickets, not shipped - 07- Other | [optional] +**method** | **str** | Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription Required for American Express SafeKey (U.S.). | [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/Riskv1decisionsOrderInformationShippingDetails.md b/docs/Riskv1decisionsOrderInformationShippingDetails.md new file mode 100644 index 00000000..2bdd73df --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationShippingDetails.md @@ -0,0 +1,11 @@ +# Riskv1decisionsOrderInformationShippingDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gift_wrap** | **bool** | Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping. | [optional] +**shipping_method** | **str** | Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription | [optional] + +[[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/Riskv1decisionsPaymentInformation.md b/docs/Riskv1decisionsPaymentInformation.md new file mode 100644 index 00000000..9c5c9c6f --- /dev/null +++ b/docs/Riskv1decisionsPaymentInformation.md @@ -0,0 +1,14 @@ +# Riskv1decisionsPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**Riskv1decisionsPaymentInformationCard**](Riskv1decisionsPaymentInformationCard.md) | | [optional] +**tokenized_card** | [**Riskv1decisionsPaymentInformationTokenizedCard**](Riskv1decisionsPaymentInformationTokenizedCard.md) | | [optional] +**customer** | [**Ptsv2paymentsPaymentInformationCustomer**](Ptsv2paymentsPaymentInformationCustomer.md) | | [optional] +**bank** | [**Ptsv2paymentsPaymentInformationBank**](Ptsv2paymentsPaymentInformationBank.md) | | [optional] +**method** | **str** | Method of payment used for the order. This field can contain one of the following values: - `consumer` (default): Customer credit card - `corporate`: Corporate credit card - `debit`: Debit card, such as a Maestro (UK Domestic) card - `cod`: Collect on delivery - `check`: Electronic check - `p2p`: Person-to-person payment - `private1`: Private label credit card - `other`: Other payment method | [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/Riskv1decisionsPaymentInformationCard.md b/docs/Riskv1decisionsPaymentInformationCard.md new file mode 100644 index 00000000..efe8850b --- /dev/null +++ b/docs/Riskv1decisionsPaymentInformationCard.md @@ -0,0 +1,14 @@ +# Riskv1decisionsPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**bin** | **str** | description: The BIN is the first six digits of the card's Primary Account Number (PAN). | [optional] +**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] +**expiration_year** | **str** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [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/Riskv1decisionsPaymentInformationTokenizedCard.md b/docs/Riskv1decisionsPaymentInformationTokenizedCard.md new file mode 100644 index 00000000..15d2fec5 --- /dev/null +++ b/docs/Riskv1decisionsPaymentInformationTokenizedCard.md @@ -0,0 +1,14 @@ +# Riskv1decisionsPaymentInformationTokenizedCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | [optional] +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**number** | **str** | Customer's payment network token value. | [optional] +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [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/Riskv1decisionsProcessingInformation.md b/docs/Riskv1decisionsProcessingInformation.md new file mode 100644 index 00000000..0aafc6f2 --- /dev/null +++ b/docs/Riskv1decisionsProcessingInformation.md @@ -0,0 +1,10 @@ +# Riskv1decisionsProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action_list** | **list[str]** | - Use `CONSUMER_AUTHENTICATION` to use Payer Authentication along with Decision Manager. For any other value, only Decision Manager will run. - Use `WATCHLIST_SCREENING` when you want to call Watchlist Screening 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/Riskv1decisionsProcessorInformation.md b/docs/Riskv1decisionsProcessorInformation.md new file mode 100644 index 00000000..4b9d5079 --- /dev/null +++ b/docs/Riskv1decisionsProcessorInformation.md @@ -0,0 +1,11 @@ +# Riskv1decisionsProcessorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avs** | [**Riskv1decisionsProcessorInformationAvs**](Riskv1decisionsProcessorInformationAvs.md) | | [optional] +**card_verification** | [**Riskv1decisionsProcessorInformationCardVerification**](Riskv1decisionsProcessorInformationCardVerification.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/Riskv1decisionsProcessorInformationAvs.md b/docs/Riskv1decisionsProcessorInformationAvs.md new file mode 100644 index 00000000..dc90b487 --- /dev/null +++ b/docs/Riskv1decisionsProcessorInformationAvs.md @@ -0,0 +1,10 @@ +# Riskv1decisionsProcessorInformationAvs + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Value returned for address verification from the Payments Authorization response. | [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/Riskv1decisionsProcessorInformationCardVerification.md b/docs/Riskv1decisionsProcessorInformationCardVerification.md new file mode 100644 index 00000000..0ff7503f --- /dev/null +++ b/docs/Riskv1decisionsProcessorInformationCardVerification.md @@ -0,0 +1,10 @@ +# Riskv1decisionsProcessorInformationCardVerification + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result_code** | **str** | 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/Riskv1decisionsRiskInformation.md b/docs/Riskv1decisionsRiskInformation.md new file mode 100644 index 00000000..154c1197 --- /dev/null +++ b/docs/Riskv1decisionsRiskInformation.md @@ -0,0 +1,13 @@ +# Riskv1decisionsRiskInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**profile** | [**Ptsv2paymentsRiskInformationProfile**](Ptsv2paymentsRiskInformationProfile.md) | | [optional] +**event_type** | **str** | Specifies one of the following types of events: - login - account_creation - account_update For regular payment transactions, do not send this field. | [optional] +**buyer_history** | [**Ptsv2paymentsRiskInformationBuyerHistory**](Ptsv2paymentsRiskInformationBuyerHistory.md) | | [optional] +**auxiliary_data** | [**list[Ptsv2paymentsRiskInformationAuxiliaryData]**](Ptsv2paymentsRiskInformationAuxiliaryData.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/Riskv1decisionsTokenInformation.md b/docs/Riskv1decisionsTokenInformation.md new file mode 100644 index 00000000..3be7ce46 --- /dev/null +++ b/docs/Riskv1decisionsTokenInformation.md @@ -0,0 +1,10 @@ +# Riskv1decisionsTokenInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jti** | **str** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [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/Riskv1decisionsTravelInformation.md b/docs/Riskv1decisionsTravelInformation.md new file mode 100644 index 00000000..399b66f5 --- /dev/null +++ b/docs/Riskv1decisionsTravelInformation.md @@ -0,0 +1,16 @@ +# Riskv1decisionsTravelInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**actual_final_destination** | **str** | IATA Code for the actual final destination that the customer intends to travel to. It should be a destination on the completeRoute. | [optional] +**complete_route** | **str** | Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn], for example, SFO-JFK:JFK-LHR:LHR-CDG. For airport codes, see the IATA Airline and Airport Code Search. Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the value of _complete_route takes precedence over that of the _leg# fields. | [optional] +**departure_time** | **str** | Departure date and time of the first leg of the trip. Use one of the following formats: - yyyy-MM-dd HH:mm z - yyyy-MM-dd hh:mm a z - yyyy-MM-dd hh:mma z HH = hour in 24-hour format hh = hour in 12-hour format a = am or pm (case insensitive) z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure. Important For travel information, use GMT instead of UTC, or use the local time zone. Examples 2011-03-20 11:30 PM PDT 2011-03-20 11:30pm GMT 2011-03-20 11:30pm GMT-05:00 Eastern Standard Time: GMT-05:00 or EST Note When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset. | [optional] +**journey_type** | **str** | Type of travel, for example one way or round trip. | [optional] +**legs** | [**list[Riskv1decisionsTravelInformationLegs]**](Riskv1decisionsTravelInformationLegs.md) | | [optional] +**number_of_passengers** | **int** | Number of passengers for whom the ticket was issued. If you do not include this field in your request, CyberSource uses a default value of 1. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] +**passengers** | [**list[Riskv1decisionsTravelInformationPassengers]**](Riskv1decisionsTravelInformationPassengers.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/Riskv1decisionsTravelInformationLegs.md b/docs/Riskv1decisionsTravelInformationLegs.md new file mode 100644 index 00000000..8cae2e98 --- /dev/null +++ b/docs/Riskv1decisionsTravelInformationLegs.md @@ -0,0 +1,14 @@ +# Riskv1decisionsTravelInformationLegs + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**origination** | **str** | Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: `travelInformation.legs.0.origination=SFO` `travelInformation.legs.1.origination=SFO` **Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_orig` 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] +**destination** | **str** | Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see [IATA Airline and Airport Code Search](https://www.iata.org/publications/Pages/code-search.aspx). The leg number can be a positive integer from 0 to N. For example: `travelInformation.legs.0.destination=SFO` `travelInformation.legs.1.destination=SFO` **Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_dest` 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] +**carrier_code** | **str** | International Air Transport Association (IATA) code for the carrier for this leg of the trip. Required for each leg. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] +**departure_date** | **str** | Departure date for the first leg of the trip. Format: YYYYMMDD. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] +**departure_time** | **int** | Time of departure for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be `00-23` and the minutes must be `00-59`. Format: English characters only. Optional request field for travel legs. | [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/Riskv1decisionsTravelInformationPassengers.md b/docs/Riskv1decisionsTravelInformationPassengers.md new file mode 100644 index 00000000..cada65a9 --- /dev/null +++ b/docs/Riskv1decisionsTravelInformationPassengers.md @@ -0,0 +1,11 @@ +# Riskv1decisionsTravelInformationPassengers + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | First name of the passenger to whom the ticket was issued. If there are multiple passengers, include all listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Required for American Express SafeKey (U.S.) for travel-related requests. | [optional] +**last_name** | **str** | Last name of the passenger to whom the ticket was issued. If there are multiple passengers, include all listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Required for American Express SafeKey (U.S.) for travel-related requests. | [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/Riskv1decisionsidactionsDecisionInformation.md b/docs/Riskv1decisionsidactionsDecisionInformation.md new file mode 100644 index 00000000..8bdd301e --- /dev/null +++ b/docs/Riskv1decisionsidactionsDecisionInformation.md @@ -0,0 +1,11 @@ +# Riskv1decisionsidactionsDecisionInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**decision** | **str** | Decision that will be applied to the given case. Possible values are: - `ACCEPT` - `REJECT` | [optional] +**comments** | **str** | Notes from the reviewer about the decision made to this case. | [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/Riskv1decisionsidactionsProcessingInformation.md b/docs/Riskv1decisionsidactionsProcessingInformation.md new file mode 100644 index 00000000..31641c64 --- /dev/null +++ b/docs/Riskv1decisionsidactionsProcessingInformation.md @@ -0,0 +1,10 @@ +# Riskv1decisionsidactionsProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action_list** | **list[str]** | Follow-on action to apply to the case after the decision is successfully applied. Possible values are one of the following: - `CAPTURE` - `REVERSE` If decision is ACCEPT, then CAPTURE can be used in actionList. If decision is REJECT, then REVERSE can be 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/Riskv1decisionsidmarkingRiskInformation.md b/docs/Riskv1decisionsidmarkingRiskInformation.md new file mode 100644 index 00000000..df8330d9 --- /dev/null +++ b/docs/Riskv1decisionsidmarkingRiskInformation.md @@ -0,0 +1,10 @@ +# Riskv1decisionsidmarkingRiskInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**marking_details** | [**Riskv1decisionsidmarkingRiskInformationMarkingDetails**](Riskv1decisionsidmarkingRiskInformationMarkingDetails.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/Riskv1decisionsidmarkingRiskInformationMarkingDetails.md b/docs/Riskv1decisionsidmarkingRiskInformationMarkingDetails.md new file mode 100644 index 00000000..71bcb817 --- /dev/null +++ b/docs/Riskv1decisionsidmarkingRiskInformationMarkingDetails.md @@ -0,0 +1,13 @@ +# Riskv1decisionsidmarkingRiskInformationMarkingDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notes** | **str** | Notes or details that explain the reasons for marking the transaction as suspect or otherwise. | [optional] +**reason** | **str** | Reason for marking the transaction as suspect or otherwise. This field can contain one of the following values: - `fraud_chargeback:` You have received a fraud-related chargeback for the transaction. - `non_fraud_chargeback:` You have received a non-fraudulent chargeback for the transaction. - `suspected:` You believe that you will probably receive a chargeback for the transaction. - `creditback:` You issued a refund to the customer to avoid a chargeback for the transaction. | [optional] +**fields_included** | **list[str]** | This field can contain one or more of the following values. When you specify more than one value, separate them with commas (,). - `account_key_hash` - `customer_account_id` - `customer_email` - `customer_ipaddress` - `customer_phone` - `device_fingerprint` - `ship_address` If no value is specified, `account_key_hash`, `customer_email`, and `ship_address` are used by default. Note `account_key_hash` adds the field that contains the card number (`customer_cc_number`). | [optional] +**action** | **str** | This field can contain one of the following values: - add: Mark as Suspect. - clear: Clear Mark as Suspect. - hide: Remove from history. | [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/Riskv1exportcomplianceinquiriesDeviceInformation.md b/docs/Riskv1exportcomplianceinquiriesDeviceInformation.md new file mode 100644 index 00000000..0af76722 --- /dev/null +++ b/docs/Riskv1exportcomplianceinquiriesDeviceInformation.md @@ -0,0 +1,11 @@ +# Riskv1exportcomplianceinquiriesDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] +**host_name** | **str** | DNS resolved hostname from `ipAddress`. | [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/Riskv1exportcomplianceinquiriesExportComplianceInformation.md b/docs/Riskv1exportcomplianceinquiriesExportComplianceInformation.md new file mode 100644 index 00000000..e5c52a38 --- /dev/null +++ b/docs/Riskv1exportcomplianceinquiriesExportComplianceInformation.md @@ -0,0 +1,12 @@ +# Riskv1exportcomplianceinquiriesExportComplianceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address_operator** | **str** | Parts of the customer's information that must match with an entry in the DPL (denied parties list) before a match occurs. This field can contain one of the following values: - AND: (default) The customer's name or company and the customer's address must appear in the database. - OR: The customer's name must appear in the database. - IGNORE: You want the service to detect a match only of the customer's name or company but not of the address. | [optional] +**weights** | [**Ptsv2paymentsWatchlistScreeningInformationWeights**](Ptsv2paymentsWatchlistScreeningInformationWeights.md) | | [optional] +**sanction_lists** | **list[str]** | Use this field to specify which list(s) you want checked with the request. The reply will include the list name as well as the response data. To check against multiple lists, enter multiple list codes separated by a caret (^). For more information, see \"Restricted and Denied Parties List,\" page 68. | [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/Riskv1exportcomplianceinquiriesOrderInformation.md b/docs/Riskv1exportcomplianceinquiriesOrderInformation.md new file mode 100644 index 00000000..ea1f99c6 --- /dev/null +++ b/docs/Riskv1exportcomplianceinquiriesOrderInformation.md @@ -0,0 +1,12 @@ +# Riskv1exportcomplianceinquiriesOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bill_to** | [**Riskv1exportcomplianceinquiriesOrderInformationBillTo**](Riskv1exportcomplianceinquiriesOrderInformationBillTo.md) | | [optional] +**ship_to** | [**Riskv1exportcomplianceinquiriesOrderInformationShipTo**](Riskv1exportcomplianceinquiriesOrderInformationShipTo.md) | | [optional] +**line_items** | [**list[Riskv1exportcomplianceinquiriesOrderInformationLineItems]**](Riskv1exportcomplianceinquiriesOrderInformationLineItems.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/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md new file mode 100644 index 00000000..406ac401 --- /dev/null +++ b/docs/Riskv1exportcomplianceinquiriesOrderInformationBillTo.md @@ -0,0 +1,21 @@ +# Riskv1exportcomplianceinquiriesOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | 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. | +**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] +**address3** | **str** | Additional address information (third line of the billing address) | [optional] +**address4** | **str** | Additional address information (fourth line of the billing address) | [optional] +**administrative_area** | **str** | 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] +**country** | **str** | 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. | +**locality** | **str** | 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. | +**postal_code** | **str** | 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. | +**company** | [**Riskv1exportcomplianceinquiriesOrderInformationBillToCompany**](Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md) | | [optional] +**first_name** | **str** | 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] +**last_name** | **str** | 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** | **str** | 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/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md new file mode 100644 index 00000000..1339ef8a --- /dev/null +++ b/docs/Riskv1exportcomplianceinquiriesOrderInformationBillToCompany.md @@ -0,0 +1,10 @@ +# Riskv1exportcomplianceinquiriesOrderInformationBillToCompany + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Company name of person buying the product. Important: This field or billTo.firstName and billTo.lastName must be present. Else, your request will fail. | [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/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md new file mode 100644 index 00000000..23663c0e --- /dev/null +++ b/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md @@ -0,0 +1,17 @@ +# Riskv1exportcomplianceinquiriesOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unit_price** | **str** | Per-item price of the product. If line items are present in the request, the unit price is a mandatory field. | [optional] +**allowed_export_countries** | **list[str]** | | [optional] +**restricted_export_countries** | **list[str]** | | [optional] +**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] +**product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] +**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [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/Riskv1exportcomplianceinquiriesOrderInformationShipTo.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationShipTo.md new file mode 100644 index 00000000..590468fd --- /dev/null +++ b/docs/Riskv1exportcomplianceinquiriesOrderInformationShipTo.md @@ -0,0 +1,12 @@ +# Riskv1exportcomplianceinquiriesOrderInformationShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] +**last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 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/Riskv1liststypeentriesBuyerInformation.md b/docs/Riskv1liststypeentriesBuyerInformation.md new file mode 100644 index 00000000..6c9de4ff --- /dev/null +++ b/docs/Riskv1liststypeentriesBuyerInformation.md @@ -0,0 +1,10 @@ +# Riskv1liststypeentriesBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**personal_identification** | [**list[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/Riskv1liststypeentriesClientReferenceInformation.md b/docs/Riskv1liststypeentriesClientReferenceInformation.md new file mode 100644 index 00000000..fd8187b1 --- /dev/null +++ b/docs/Riskv1liststypeentriesClientReferenceInformation.md @@ -0,0 +1,12 @@ +# Riskv1liststypeentriesClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | 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. | +**comments** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] +**partner** | [**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/Riskv1liststypeentriesDeviceInformation.md b/docs/Riskv1liststypeentriesDeviceInformation.md new file mode 100644 index 00000000..d2518fe1 --- /dev/null +++ b/docs/Riskv1liststypeentriesDeviceInformation.md @@ -0,0 +1,11 @@ +# Riskv1liststypeentriesDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] +**network_ip_address** | **str** | Network IP address of the customer (for example, 10.1.27). A network IP address includes up to 256 IP addresses. | [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/Riskv1liststypeentriesOrderInformation.md b/docs/Riskv1liststypeentriesOrderInformation.md new file mode 100644 index 00000000..cea770fc --- /dev/null +++ b/docs/Riskv1liststypeentriesOrderInformation.md @@ -0,0 +1,13 @@ +# Riskv1liststypeentriesOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address** | [**Riskv1liststypeentriesOrderInformationAddress**](Riskv1liststypeentriesOrderInformationAddress.md) | | [optional] +**bill_to** | [**Riskv1liststypeentriesOrderInformationBillTo**](Riskv1liststypeentriesOrderInformationBillTo.md) | | [optional] +**ship_to** | [**Riskv1liststypeentriesOrderInformationShipTo**](Riskv1liststypeentriesOrderInformationShipTo.md) | | [optional] +**line_items** | [**list[Riskv1liststypeentriesOrderInformationLineItems]**](Riskv1liststypeentriesOrderInformationLineItems.md) | This array contains detailed information about individual products in 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/Riskv1liststypeentriesOrderInformationAddress.md b/docs/Riskv1liststypeentriesOrderInformationAddress.md new file mode 100644 index 00000000..dd2a46e9 --- /dev/null +++ b/docs/Riskv1liststypeentriesOrderInformationAddress.md @@ -0,0 +1,15 @@ +# Riskv1liststypeentriesOrderInformationAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | First line of the street address | [optional] +**address2** | **str** | Second line of the street address | [optional] +**locality** | **str** | City of the street address. Required when adding the address to a list. | [optional] +**country** | **str** | Country of the street address. Use the two-character codes located in the Support Center. Required if address1 is present. | [optional] +**administrative_area** | **str** | State, province, or territory of the street address. Use the two-character codes located in the Support Center. | [optional] +**postal_code** | **str** | Postal code of the street address. Required when adding the address to a list. | [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/Riskv1liststypeentriesOrderInformationBillTo.md b/docs/Riskv1liststypeentriesOrderInformationBillTo.md new file mode 100644 index 00000000..e91c6c7a --- /dev/null +++ b/docs/Riskv1liststypeentriesOrderInformationBillTo.md @@ -0,0 +1,20 @@ +# Riskv1liststypeentriesOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | 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] +**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] +**administrative_area** | **str** | 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] +**country** | **str** | 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] +**locality** | **str** | 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] +**postal_code** | **str** | 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] +**first_name** | **str** | 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] +**last_name** | **str** | 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] +**phone_number** | **str** | 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** | **str** | 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] +**email_domain** | **str** | 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/Riskv1liststypeentriesOrderInformationLineItems.md b/docs/Riskv1liststypeentriesOrderInformationLineItems.md new file mode 100644 index 00000000..755d5de8 --- /dev/null +++ b/docs/Riskv1liststypeentriesOrderInformationLineItems.md @@ -0,0 +1,10 @@ +# Riskv1liststypeentriesOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [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/Riskv1liststypeentriesOrderInformationShipTo.md b/docs/Riskv1liststypeentriesOrderInformationShipTo.md new file mode 100644 index 00000000..0f04406c --- /dev/null +++ b/docs/Riskv1liststypeentriesOrderInformationShipTo.md @@ -0,0 +1,15 @@ +# Riskv1liststypeentriesOrderInformationShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [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/Riskv1liststypeentriesPaymentInformation.md b/docs/Riskv1liststypeentriesPaymentInformation.md new file mode 100644 index 00000000..db8da6c1 --- /dev/null +++ b/docs/Riskv1liststypeentriesPaymentInformation.md @@ -0,0 +1,11 @@ +# Riskv1liststypeentriesPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**Riskv1liststypeentriesPaymentInformationCard**](Riskv1liststypeentriesPaymentInformationCard.md) | | [optional] +**bank** | [**Riskv1liststypeentriesPaymentInformationBank**](Riskv1liststypeentriesPaymentInformationBank.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/Riskv1liststypeentriesPaymentInformationBank.md b/docs/Riskv1liststypeentriesPaymentInformationBank.md new file mode 100644 index 00000000..a5e7a33c --- /dev/null +++ b/docs/Riskv1liststypeentriesPaymentInformationBank.md @@ -0,0 +1,13 @@ +# Riskv1liststypeentriesPaymentInformationBank + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_number** | **str** | Customer's bank account number. You can use this field only when scoring a direct debit transaction. Use this field if you do not or are not allowed to provide the IBAN. Note Do not use the IBAN in this field. Use nly the traditional account number information. For the IBAN, use bank_iban. | [optional] +**code** | **str** | 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 specific requirements, see \"Required Bank Account Information by Country,\" | [optional] +**country** | **str** | Country where the bank is located. Use the two-character ISO codes. You can use this field only when scoring a direct debit transaction. | [optional] +**iban** | **str** | 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 specific requirements, see \"Required Bank Account Information by Country,\" | [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/Riskv1liststypeentriesPaymentInformationCard.md b/docs/Riskv1liststypeentriesPaymentInformationCard.md new file mode 100644 index 00000000..66fcc23e --- /dev/null +++ b/docs/Riskv1liststypeentriesPaymentInformationCard.md @@ -0,0 +1,12 @@ +# Riskv1liststypeentriesPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**bin** | **str** | description: The BIN is the first six digits of the card's Primary Account Number (PAN). | [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/Riskv1liststypeentriesRiskInformation.md b/docs/Riskv1liststypeentriesRiskInformation.md new file mode 100644 index 00000000..7266c5ec --- /dev/null +++ b/docs/Riskv1liststypeentriesRiskInformation.md @@ -0,0 +1,10 @@ +# Riskv1liststypeentriesRiskInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**marking_details** | [**Riskv1liststypeentriesRiskInformationMarkingDetails**](Riskv1liststypeentriesRiskInformationMarkingDetails.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/Riskv1liststypeentriesRiskInformationMarkingDetails.md b/docs/Riskv1liststypeentriesRiskInformationMarkingDetails.md new file mode 100644 index 00000000..ff2f4b00 --- /dev/null +++ b/docs/Riskv1liststypeentriesRiskInformationMarkingDetails.md @@ -0,0 +1,13 @@ +# Riskv1liststypeentriesRiskInformationMarkingDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notes** | **str** | Notes or details that explain the reasons for adding the transaction to either the positive or negative list. | [optional] +**reason** | **str** | Reason for adding the transaction to the negative list. This field can contain one of the following values: - `fraud_chargeback:` You have received a fraud-related chargeback for the transaction. - `non_fraud_chargeback:` You have received a non-fraudulent chargeback for the transaction. - `suspected:` You believe that you will probably receive a chargeback for the transaction. - `creditback:` You issued a refund to the customer to avoid a chargeback for the transaction. | [optional] +**record_name** | **str** | Name of the customer's record entered in the list. For the positive list, it is required if `action_ code`=`add_positive`. If absent from the request, `ics_risk_update` creates the value for this field by concatenating the customer's first and last names. For the negative and the review lists, `record_name`, `customer_firstname`, and `customer_lastname` are optional. | [optional] +**action** | **str** | Indicates whether to add to or remove a customer's identity from the negative or positive list. This field can contain one of the following values: - add: Add information to the list. - convert: moves the data. - delete: deletes the data from the list. | [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/SAConfig.md b/docs/SAConfig.md new file mode 100644 index 00000000..94fdabd1 --- /dev/null +++ b/docs/SAConfig.md @@ -0,0 +1,16 @@ +# SAConfig + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parent_profile_id** | **str** | You can group Secure Acceptance profiles under parent profiles. By changing the parent profile, you can update all profiles underneath that parent. Specify the Parent Profile ID here. | [optional] +**contact_information** | [**SAConfigContactInformation**](SAConfigContactInformation.md) | | [optional] +**notifications** | [**SAConfigNotifications**](SAConfigNotifications.md) | | [optional] +**service** | [**SAConfigService**](SAConfigService.md) | | [optional] +**payment_methods** | [**SAConfigPaymentMethods**](SAConfigPaymentMethods.md) | | [optional] +**checkout** | [**SAConfigCheckout**](SAConfigCheckout.md) | | [optional] +**payment_types** | [**SAConfigPaymentTypes**](SAConfigPaymentTypes.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/SAConfigCheckout.md b/docs/SAConfigCheckout.md new file mode 100644 index 00000000..308975b1 --- /dev/null +++ b/docs/SAConfigCheckout.md @@ -0,0 +1,12 @@ +# SAConfigCheckout + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_tax_amount** | **bool** | Toggles whether or not the tax amount is displayed on the Hosted Checkout. | [optional] +**template_type** | **str** | Specifies whether the Hosted Checkout is displayed as a single page form or multi page checkout. Valid values: `multi` `single` | [optional] +**return_to_merchant_site_url** | **str** | URL of the website linked to from the Secure Acceptance receipt page. Only used if the profile does not have custom receipt pages configured. | [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/SAConfigContactInformation.md b/docs/SAConfigContactInformation.md new file mode 100644 index 00000000..ddfbbd8a --- /dev/null +++ b/docs/SAConfigContactInformation.md @@ -0,0 +1,13 @@ +# SAConfigContactInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phone** | **str** | | [optional] +**company_name** | **str** | | [optional] +**email** | **str** | | [optional] +**name** | **str** | | [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/SAConfigNotifications.md b/docs/SAConfigNotifications.md new file mode 100644 index 00000000..4462e370 --- /dev/null +++ b/docs/SAConfigNotifications.md @@ -0,0 +1,11 @@ +# SAConfigNotifications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_notifications** | [**SAConfigNotificationsMerchantNotifications**](SAConfigNotificationsMerchantNotifications.md) | | [optional] +**customer_notifications** | [**SAConfigNotificationsCustomerNotifications**](SAConfigNotificationsCustomerNotifications.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/SAConfigNotificationsCustomerNotifications.md b/docs/SAConfigNotificationsCustomerNotifications.md new file mode 100644 index 00000000..90fbb9f6 --- /dev/null +++ b/docs/SAConfigNotificationsCustomerNotifications.md @@ -0,0 +1,16 @@ +# SAConfigNotificationsCustomerNotifications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**custom_receipt_page_enabled** | **bool** | Toggles the custom receipt page, where merchants can receive the results of the transaction and display appropriate messaging. Usually set by web developers integrating to Secure Acceptance. | [optional] +**receipt_email_address** | **str** | Email address where a copy of the payer's receipt email is sent, when notificationReceiptEmailEnabled is true. | [optional] +**customer_receipt_email_enabled** | **bool** | Toggles an email receipt sent to the payer's email address on payment success. | [optional] +**custom_cancel_page** | **str** | URL to which transaction results are POSTed when the payer clicks 'Cancel' on the Hosted Checkout. Triggered when customCancelPageEnabled is true. Usually set by web developers integrating to Secure Acceptance. | [optional] +**custom_receipt_page** | **str** | URL to which transaction results are POSTed when the payer requests a payment on the Hosted Checkout. Triggered when customCancelPageEnabled is true. Usually set by web developers integrating to Secure Acceptance. | [optional] +**custom_cancel_page_enabled** | **bool** | Toggles the custom cancel page, where merchants can receive notice that the payer has canceled, and display appropriate messaging and direction. Usually set by web developers integrating to Secure Acceptance. | [optional] +**notification_receipt_email_enabled** | **bool** | Toggles whether merchant receives a copy of the payer's receipt email. | [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/SAConfigNotificationsMerchantNotifications.md b/docs/SAConfigNotificationsMerchantNotifications.md new file mode 100644 index 00000000..e8d164a8 --- /dev/null +++ b/docs/SAConfigNotificationsMerchantNotifications.md @@ -0,0 +1,14 @@ +# SAConfigNotificationsMerchantNotifications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backoffice_post_enabled** | **bool** | Enables Webhook transaction confirmation messages sent to URL defined in backofficePostUrl. Usually enabled by web developers integrating to Secure Acceptance. | [optional] +**backoffice_email_address** | **str** | Email address to receive transaction confirmation messages. | [optional] +**backoffice_email_enabled** | **bool** | Enables email transaction confirmation messages, sent to the address specified in backofficeEmailAddress. | [optional] +**backoffice_post_url** | **str** | Webhook URL to which transaction confirmation is sent. Usually completed by the web developers integrating to Secure Acceptance. | [optional] +**card_number_format** | **str** | Format in which the card number should be masked in the notifications. Valid values: `1` - Display first 6 digits only (e.g. \"444433**********\") `2` - Display last four digits only (e.g. \"************1111\") `3` - Display First six and last four digits (e.g. \"444433******1111\") | [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/SAConfigPaymentMethods.md b/docs/SAConfigPaymentMethods.md new file mode 100644 index 00000000..cfb7bae8 --- /dev/null +++ b/docs/SAConfigPaymentMethods.md @@ -0,0 +1,10 @@ +# SAConfigPaymentMethods + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled_payment_methods** | **list[str]** | | [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/SAConfigPaymentTypes.md b/docs/SAConfigPaymentTypes.md new file mode 100644 index 00000000..46affd03 --- /dev/null +++ b/docs/SAConfigPaymentTypes.md @@ -0,0 +1,10 @@ +# SAConfigPaymentTypes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_types** | [**SAConfigPaymentTypesCardTypes**](SAConfigPaymentTypesCardTypes.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/SAConfigPaymentTypesCardTypes.md b/docs/SAConfigPaymentTypesCardTypes.md new file mode 100644 index 00000000..04a436aa --- /dev/null +++ b/docs/SAConfigPaymentTypesCardTypes.md @@ -0,0 +1,13 @@ +# SAConfigPaymentTypesCardTypes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**discover** | [**SAConfigPaymentTypesCardTypesDiscover**](SAConfigPaymentTypesCardTypesDiscover.md) | | [optional] +**amex** | [**SAConfigPaymentTypesCardTypesDiscover**](SAConfigPaymentTypesCardTypesDiscover.md) | | [optional] +**master_card** | [**SAConfigPaymentTypesCardTypesDiscover**](SAConfigPaymentTypesCardTypesDiscover.md) | | [optional] +**visa** | [**SAConfigPaymentTypesCardTypesDiscover**](SAConfigPaymentTypesCardTypesDiscover.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/SAConfigPaymentTypesCardTypesDiscover.md b/docs/SAConfigPaymentTypesCardTypesDiscover.md new file mode 100644 index 00000000..f53d8305 --- /dev/null +++ b/docs/SAConfigPaymentTypesCardTypesDiscover.md @@ -0,0 +1,16 @@ +# SAConfigPaymentTypesCardTypesDiscover + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_verification_number_supported** | **bool** | Dictates whether or Card Verification Number is supported by the card type. Usually this is set at system level. | [optional] +**card_verification_number_display** | **bool** | Toggles whether or Card Verification Number is displayed on the Hosted Checkout. | [optional] +**payer_authentication_supported** | **bool** | Dictates whether or Payer Authentication is supported by the card type. Usually this is set at system level. | [optional] +**supported_currencies** | **list[str]** | Array of the supported ISO 4217 alphabetic currency codes. | [optional] +**method** | **str** | | [optional] +**card_verification_number_required** | **bool** | | [optional] +**payer_authentication_enabled** | **bool** | | [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/SAConfigService.md b/docs/SAConfigService.md new file mode 100644 index 00000000..cc4a4815 --- /dev/null +++ b/docs/SAConfigService.md @@ -0,0 +1,16 @@ +# SAConfigService + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**decision_manager_verbose_enabled** | **bool** | Toggles whether verbose Decision Manager results should be present in the Secure Acceptance response. As this response passes through the browser, it is recommended to set this to \"false\" outside of debugging. | [optional] +**declined_retry_limit** | **float** | Defines the number of retries a payer is presented with on payment declines on Hosted Checkout. Valid values are between 0 and 5. | [optional] +**decision_manager_enabled** | **bool** | Toggles whether Decision Manager is enabled or not for Secure Acceptance transactions. Requires the transacting MID to be enabled and configured for Decicion Manager. | [optional] +**tokenization_enabled** | **bool** | Toggles whether Tokenization is enabled or not for Secure Acceptance transactions. Requires the transacting MID to be enabled and configured for Tokenization. | [optional] +**reverse_auth_on_address_verification_system_failure** | **bool** | Toggles whether or not an approved Authorization that fails AVS should be automatically reversed. | [optional] +**device_fingerprint_enabled** | **bool** | Toggles whether or not fraud Device Fingerprinting is enabled on the Hosted Checkout. This simplifies enablement for Decision Manager. | [optional] +**reverse_auth_on_card_verification_number_failure** | **bool** | Toggles whether or not an approved Authorization that fails CVN check that should be automatically reversed. | [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/SaveAsymEgressKey.md b/docs/SaveAsymEgressKey.md new file mode 100644 index 00000000..ce800c9f --- /dev/null +++ b/docs/SaveAsymEgressKey.md @@ -0,0 +1,12 @@ +# SaveAsymEgressKey + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Kmsegressv2keysasymClientReferenceInformation**](Kmsegressv2keysasymClientReferenceInformation.md) | | [optional] +**client_request_action** | **str** | Client request action. | [optional] +**key_information** | [**Kmsegressv2keysasymKeyInformation**](Kmsegressv2keysasymKeyInformation.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/SaveSymEgressKey.md b/docs/SaveSymEgressKey.md new file mode 100644 index 00000000..1ea84716 --- /dev/null +++ b/docs/SaveSymEgressKey.md @@ -0,0 +1,12 @@ +# SaveSymEgressKey + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Kmsegressv2keyssymClientReferenceInformation**](Kmsegressv2keyssymClientReferenceInformation.md) | | [optional] +**client_request_action** | **str** | Client request action. | [optional] +**key_information** | [**Kmsegressv2keyssymKeyInformation**](Kmsegressv2keyssymKeyInformation.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/SearchRequest.md b/docs/SearchRequest.md new file mode 100644 index 00000000..1843a410 --- /dev/null +++ b/docs/SearchRequest.md @@ -0,0 +1,13 @@ +# SearchRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | This is the orgId of the organization which the user belongs to. | [optional] +**user_name** | **str** | User ID of the user you want to get details on. | [optional] +**role_id** | **str** | role of the user you are trying to search on. | [optional] +**permission_id** | **str** | permission that you are trying to search user on. | [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/SearchTransactionsApi.md b/docs/SearchTransactionsApi.md new file mode 100644 index 00000000..803a3973 --- /dev/null +++ b/docs/SearchTransactionsApi.md @@ -0,0 +1,106 @@ +# CyberSource.SearchTransactionsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_search**](SearchTransactionsApi.md#create_search) | **POST** /tss/v2/searches | Create a Search Request +[**get_search**](SearchTransactionsApi.md#get_search) | **GET** /tss/v2/searches/{searchId} | Get Search Results + + +# **create_search** +> TssV2TransactionsPost201Response create_search(create_search_request) + +Create a Search Request + +Create a search request. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SearchTransactionsApi() +create_search_request = CyberSource.CreateSearchRequest() # CreateSearchRequest | + +try: + # Create a Search Request + api_response = api_instance.create_search(create_search_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling SearchTransactionsApi->create_search: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_search_request** | [**CreateSearchRequest**](CreateSearchRequest.md)| | + +### Return type + +[**TssV2TransactionsPost201Response**](TssV2TransactionsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_search** +> TssV2TransactionsPost201Response get_search(search_id) + +Get Search Results + +Include the Search ID in the GET request to retrieve the search results. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SearchTransactionsApi() +search_id = 'search_id_example' # str | Search ID. + +try: + # Get Search Results + api_response = api_instance.get_search(search_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling SearchTransactionsApi->get_search: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_id** | **str**| Search ID. | + +### Return type + +[**TssV2TransactionsPost201Response**](TssV2TransactionsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SecureFileShareApi.md b/docs/SecureFileShareApi.md new file mode 100644 index 00000000..de76750b --- /dev/null +++ b/docs/SecureFileShareApi.md @@ -0,0 +1,113 @@ +# CyberSource.SecureFileShareApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_file**](SecureFileShareApi.md#get_file) | **GET** /sfs/v1/files/{fileId} | Download a File with File Identifier +[**get_file_detail**](SecureFileShareApi.md#get_file_detail) | **GET** /sfs/v1/file-details | Get List of Files + + +# **get_file** +> get_file(file_id, organization_id=organization_id) + +Download a File with File Identifier + +Download a file for the given file identifier + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SecureFileShareApi() +file_id = 'file_id_example' # str | Unique identifier for each file +organization_id = 'organization_id_example' # str | Valid Cybersource Organization Id (optional) + +try: + # Download a File with File Identifier + api_instance.get_file(file_id, organization_id=organization_id) +except ApiException as e: + print("Exception when calling SecureFileShareApi->get_file: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file_id** | **str**| Unique identifier for each file | + **organization_id** | **str**| Valid Cybersource Organization Id | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: */*;charset=utf-8 + - **Accept**: application/xml, text/csv, application/pdf + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_file_detail** +> V1FileDetailsGet200Response get_file_detail(start_date, end_date, organization_id=organization_id, name=name) + +Get List of Files + +Get list of files and it's information of them available inside the report directory + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SecureFileShareApi() +start_date = '2013-10-20' # date | Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd +end_date = '2013-10-20' # date | Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd +organization_id = 'organization_id_example' # str | Valid Cybersource Organization Id (optional) +name = 'name_example' # str | **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml (optional) + +try: + # Get List of Files + api_response = api_instance.get_file_detail(start_date, end_date, organization_id=organization_id, name=name) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecureFileShareApi->get_file_detail: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **start_date** | **date**| Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd | + **end_date** | **date**| Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd | + **organization_id** | **str**| Valid Cybersource Organization Id | [optional] + **name** | **str**| **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml | [optional] + +### Return type + +[**V1FileDetailsGet200Response**](V1FileDetailsGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: */*;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ShippingAddressListForCustomer.md b/docs/ShippingAddressListForCustomer.md new file mode 100644 index 00000000..79d00801 --- /dev/null +++ b/docs/ShippingAddressListForCustomer.md @@ -0,0 +1,15 @@ +# ShippingAddressListForCustomer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**ShippingAddressListForCustomerLinks**](ShippingAddressListForCustomerLinks.md) | | [optional] +**offset** | **int** | The offset parameter supplied in the request. | [optional] +**limit** | **int** | The limit parameter supplied in the request. | [optional] +**count** | **int** | The number of Shipping Addresses returned in the array. | [optional] +**total** | **int** | The total number of Shipping Addresses associated with the Customer. | [optional] +**embedded** | [**ShippingAddressListForCustomerEmbedded**](ShippingAddressListForCustomerEmbedded.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/ShippingAddressListForCustomerEmbedded.md b/docs/ShippingAddressListForCustomerEmbedded.md new file mode 100644 index 00000000..b7454995 --- /dev/null +++ b/docs/ShippingAddressListForCustomerEmbedded.md @@ -0,0 +1,10 @@ +# ShippingAddressListForCustomerEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shipping_addresses** | [**list[Tmsv2customersEmbeddedDefaultShippingAddress]**](Tmsv2customersEmbeddedDefaultShippingAddress.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/ShippingAddressListForCustomerLinks.md b/docs/ShippingAddressListForCustomerLinks.md new file mode 100644 index 00000000..64bc8194 --- /dev/null +++ b/docs/ShippingAddressListForCustomerLinks.md @@ -0,0 +1,14 @@ +# ShippingAddressListForCustomerLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**ShippingAddressListForCustomerLinksSelf**](ShippingAddressListForCustomerLinksSelf.md) | | [optional] +**first** | [**ShippingAddressListForCustomerLinksFirst**](ShippingAddressListForCustomerLinksFirst.md) | | [optional] +**prev** | [**ShippingAddressListForCustomerLinksPrev**](ShippingAddressListForCustomerLinksPrev.md) | | [optional] +**next** | [**ShippingAddressListForCustomerLinksNext**](ShippingAddressListForCustomerLinksNext.md) | | [optional] +**last** | [**ShippingAddressListForCustomerLinksLast**](ShippingAddressListForCustomerLinksLast.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/ShippingAddressListForCustomerLinksFirst.md b/docs/ShippingAddressListForCustomerLinksFirst.md new file mode 100644 index 00000000..59254eae --- /dev/null +++ b/docs/ShippingAddressListForCustomerLinksFirst.md @@ -0,0 +1,10 @@ +# ShippingAddressListForCustomerLinksFirst + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the first page. | [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/ShippingAddressListForCustomerLinksLast.md b/docs/ShippingAddressListForCustomerLinksLast.md new file mode 100644 index 00000000..abbdeba7 --- /dev/null +++ b/docs/ShippingAddressListForCustomerLinksLast.md @@ -0,0 +1,10 @@ +# ShippingAddressListForCustomerLinksLast + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the last page. | [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/ShippingAddressListForCustomerLinksNext.md b/docs/ShippingAddressListForCustomerLinksNext.md new file mode 100644 index 00000000..62f7e702 --- /dev/null +++ b/docs/ShippingAddressListForCustomerLinksNext.md @@ -0,0 +1,10 @@ +# ShippingAddressListForCustomerLinksNext + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the next page. | [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/ShippingAddressListForCustomerLinksPrev.md b/docs/ShippingAddressListForCustomerLinksPrev.md new file mode 100644 index 00000000..1db7ac7f --- /dev/null +++ b/docs/ShippingAddressListForCustomerLinksPrev.md @@ -0,0 +1,10 @@ +# ShippingAddressListForCustomerLinksPrev + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the previous page. | [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/ShippingAddressListForCustomerLinksSelf.md b/docs/ShippingAddressListForCustomerLinksSelf.md new file mode 100644 index 00000000..76f39df2 --- /dev/null +++ b/docs/ShippingAddressListForCustomerLinksSelf.md @@ -0,0 +1,10 @@ +# ShippingAddressListForCustomerLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the current page. | [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/SubscriptionsApi.md b/docs/SubscriptionsApi.md new file mode 100644 index 00000000..57148b82 --- /dev/null +++ b/docs/SubscriptionsApi.md @@ -0,0 +1,406 @@ +# CyberSource.SubscriptionsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**activate_subscription**](SubscriptionsApi.md#activate_subscription) | **POST** /rbs/v1/subscriptions/{id}/activate | Activate a Subscription +[**cancel_subscription**](SubscriptionsApi.md#cancel_subscription) | **POST** /rbs/v1/subscriptions/{id}/cancel | Cancel a Subscription +[**create_subscription**](SubscriptionsApi.md#create_subscription) | **POST** /rbs/v1/subscriptions | Create a Subscription +[**get_all_subscriptions**](SubscriptionsApi.md#get_all_subscriptions) | **GET** /rbs/v1/subscriptions | Get a List of Subscriptions +[**get_subscription**](SubscriptionsApi.md#get_subscription) | **GET** /rbs/v1/subscriptions/{id} | Get a Subscription +[**get_subscription_code**](SubscriptionsApi.md#get_subscription_code) | **GET** /rbs/v1/subscriptions/code | Get a Subscription Code +[**suspend_subscription**](SubscriptionsApi.md#suspend_subscription) | **POST** /rbs/v1/subscriptions/{id}/suspend | Suspend a Subscription +[**update_subscription**](SubscriptionsApi.md#update_subscription) | **PATCH** /rbs/v1/subscriptions/{id} | Update a Subscription + + +# **activate_subscription** +> ActivateSubscriptionResponse activate_subscription(id, process_skipped_payments=process_skipped_payments) + +Activate a Subscription + +Activate a `SUSPENDED` Subscription + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsApi() +id = 'id_example' # str | Subscription Id +process_skipped_payments = true # bool | Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. (optional) (default to true) + +try: + # Activate a Subscription + api_response = api_instance.activate_subscription(id, process_skipped_payments=process_skipped_payments) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->activate_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Subscription Id | + **process_skipped_payments** | **bool**| Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. | [optional] [default to true] + +### Return type + +[**ActivateSubscriptionResponse**](ActivateSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cancel_subscription** +> CancelSubscriptionResponse cancel_subscription(id) + +Cancel a Subscription + +Cancel a Subscription + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsApi() +id = 'id_example' # str | Subscription Id + +try: + # Cancel a Subscription + api_response = api_instance.cancel_subscription(id) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->cancel_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Subscription Id | + +### Return type + +[**CancelSubscriptionResponse**](CancelSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_subscription** +> CreateSubscriptionResponse create_subscription(create_subscription_request) + +Create a Subscription + +Create a Recurring Billing Subscription + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsApi() +create_subscription_request = CyberSource.CreateSubscriptionRequest() # CreateSubscriptionRequest | + +try: + # Create a Subscription + api_response = api_instance.create_subscription(create_subscription_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->create_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_subscription_request** | [**CreateSubscriptionRequest**](CreateSubscriptionRequest.md)| | + +### Return type + +[**CreateSubscriptionResponse**](CreateSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_subscriptions** +> GetAllSubscriptionsResponse get_all_subscriptions(offset=offset, limit=limit, code=code, status=status) + +Get a List of Subscriptions + +Retrieve Subscriptions by Subscription Code & Subscription Status. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsApi() +offset = 56 # int | Page offset number. (optional) +limit = 56 # int | Number of items to be returned. Default - `20`, Max - `100` (optional) +code = 'code_example' # str | Filter by Subscription Code (optional) +status = 'status_example' # str | Filter by Subscription Status (optional) + +try: + # Get a List of Subscriptions + api_response = api_instance.get_all_subscriptions(offset=offset, limit=limit, code=code, status=status) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->get_all_subscriptions: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int**| Page offset number. | [optional] + **limit** | **int**| Number of items to be returned. Default - `20`, Max - `100` | [optional] + **code** | **str**| Filter by Subscription Code | [optional] + **status** | **str**| Filter by Subscription Status | [optional] + +### Return type + +[**GetAllSubscriptionsResponse**](GetAllSubscriptionsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_subscription** +> GetSubscriptionResponse get_subscription(id) + +Get a Subscription + +Get a Subscription by Subscription Id + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsApi() +id = 'id_example' # str | Subscription Id + +try: + # Get a Subscription + api_response = api_instance.get_subscription(id) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->get_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Subscription Id | + +### Return type + +[**GetSubscriptionResponse**](GetSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_subscription_code** +> GetSubscriptionCodeResponse get_subscription_code() + +Get a Subscription Code + +Get a Unique Subscription Code + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsApi() + +try: + # Get a Subscription Code + api_response = api_instance.get_subscription_code() + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->get_subscription_code: %s\n" % e) +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**GetSubscriptionCodeResponse**](GetSubscriptionCodeResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **suspend_subscription** +> SuspendSubscriptionResponse suspend_subscription(id) + +Suspend a Subscription + +Suspend a Subscription + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsApi() +id = 'id_example' # str | Subscription Id + +try: + # Suspend a Subscription + api_response = api_instance.suspend_subscription(id) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->suspend_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Subscription Id | + +### Return type + +[**SuspendSubscriptionResponse**](SuspendSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_subscription** +> UpdateSubscriptionResponse update_subscription(id, update_subscription) + +Update a Subscription + +Update a Subscription by Subscription Id + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsApi() +id = 'id_example' # str | Subscription Id +update_subscription = CyberSource.UpdateSubscription() # UpdateSubscription | Update Subscription + +try: + # Update a Subscription + api_response = api_instance.update_subscription(id, update_subscription) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->update_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Subscription Id | + **update_subscription** | [**UpdateSubscription**](UpdateSubscription.md)| Update Subscription | + +### Return type + +[**UpdateSubscriptionResponse**](UpdateSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SubscriptionsFollowOnsApi.md b/docs/SubscriptionsFollowOnsApi.md new file mode 100644 index 00000000..d1fe3910 --- /dev/null +++ b/docs/SubscriptionsFollowOnsApi.md @@ -0,0 +1,108 @@ +# CyberSource.SubscriptionsFollowOnsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_follow_on_subscription**](SubscriptionsFollowOnsApi.md#create_follow_on_subscription) | **POST** /rbs/v1/subscriptions/follow-ons/{requestId} | Create a Follow-On Subscription +[**get_follow_on_subscription**](SubscriptionsFollowOnsApi.md#get_follow_on_subscription) | **GET** /rbs/v1/subscriptions/follow-ons/{requestId} | Get a Follow-On Subscription + + +# **create_follow_on_subscription** +> CreateSubscriptionResponse create_follow_on_subscription(request_id, create_subscription_request) + +Create a Follow-On Subscription + +Create a new Subscription based on the Request Id of an existing successful Transaction. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsFollowOnsApi() +request_id = 'request_id_example' # str | Request Id of an existing successful Transaction +create_subscription_request = CyberSource.CreateSubscriptionRequest1() # CreateSubscriptionRequest1 | + +try: + # Create a Follow-On Subscription + api_response = api_instance.create_follow_on_subscription(request_id, create_subscription_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsFollowOnsApi->create_follow_on_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_id** | **str**| Request Id of an existing successful Transaction | + **create_subscription_request** | [**CreateSubscriptionRequest1**](CreateSubscriptionRequest1.md)| | + +### Return type + +[**CreateSubscriptionResponse**](CreateSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_follow_on_subscription** +> GetSubscriptionResponse1 get_follow_on_subscription(request_id) + +Get a Follow-On Subscription + +Get details of the Subscription being created based on the Request Id of an existing successful Transaction. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.SubscriptionsFollowOnsApi() +request_id = 'request_id_example' # str | Request Id of an existing successful Transaction + +try: + # Get a Follow-On Subscription + api_response = api_instance.get_follow_on_subscription(request_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsFollowOnsApi->get_follow_on_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_id** | **str**| Request Id of an existing successful Transaction | + +### Return type + +[**GetSubscriptionResponse1**](GetSubscriptionResponse1.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SuspendSubscriptionResponse.md b/docs/SuspendSubscriptionResponse.md new file mode 100644 index 00000000..13e87be6 --- /dev/null +++ b/docs/SuspendSubscriptionResponse.md @@ -0,0 +1,14 @@ +# SuspendSubscriptionResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - ACCEPTED | [optional] +**subscription_information** | [**SuspendSubscriptionResponseSubscriptionInformation**](SuspendSubscriptionResponseSubscriptionInformation.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/SuspendSubscriptionResponseSubscriptionInformation.md b/docs/SuspendSubscriptionResponseSubscriptionInformation.md new file mode 100644 index 00000000..4e71202d --- /dev/null +++ b/docs/SuspendSubscriptionResponseSubscriptionInformation.md @@ -0,0 +1,11 @@ +# SuspendSubscriptionResponseSubscriptionInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Subscription code. | [optional] +**status** | **str** | Subscription Status: - `SUSPENDED` | [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/TaxRequest.md b/docs/TaxRequest.md new file mode 100644 index 00000000..ce890e69 --- /dev/null +++ b/docs/TaxRequest.md @@ -0,0 +1,14 @@ +# TaxRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Vasv2taxClientReferenceInformation**](Vasv2taxClientReferenceInformation.md) | | [optional] +**tax_information** | [**Vasv2taxTaxInformation**](Vasv2taxTaxInformation.md) | | [optional] +**order_information** | [**Vasv2taxOrderInformation**](Vasv2taxOrderInformation.md) | | [optional] +**merchant_information** | [**Vasv2taxMerchantInformation**](Vasv2taxMerchantInformation.md) | | [optional] +**buyer_information** | [**Vasv2taxBuyerInformation**](Vasv2taxBuyerInformation.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/TaxesApi.md b/docs/TaxesApi.md new file mode 100644 index 00000000..e7f42d02 --- /dev/null +++ b/docs/TaxesApi.md @@ -0,0 +1,108 @@ +# CyberSource.TaxesApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**calculate_tax**](TaxesApi.md#calculate_tax) | **POST** /vas/v2/tax | Calculate Taxes +[**void_tax**](TaxesApi.md#void_tax) | **PATCH** /vas/v2/tax/{id} | Void Taxes + + +# **calculate_tax** +> VasV2PaymentsPost201Response calculate_tax(tax_request) + +Calculate Taxes + +The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide. It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation. The service supports product-based tax rules and exemptions for goods and services. The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TaxesApi() +tax_request = CyberSource.TaxRequest() # TaxRequest | + +try: + # Calculate Taxes + api_response = api_instance.calculate_tax(tax_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->calculate_tax: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tax_request** | [**TaxRequest**](TaxRequest.md)| | + +### Return type + +[**VasV2PaymentsPost201Response**](VasV2PaymentsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **void_tax** +> VasV2TaxVoid200Response void_tax(void_tax_request, id) + +Void Taxes + +Pass the Tax Request ID in the PATCH request to void the committed tax calculation. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TaxesApi() +void_tax_request = CyberSource.VoidTaxRequest() # VoidTaxRequest | +id = 'id_example' # str | The tax ID returned from a previous request. + +try: + # Void Taxes + api_response = api_instance.void_tax(void_tax_request, id) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->void_tax: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **void_tax_request** | [**VoidTaxRequest**](VoidTaxRequest.md)| | + **id** | **str**| The tax ID returned from a previous request. | + +### Return type + +[**VasV2TaxVoid200Response**](VasV2TaxVoid200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TmsAuthorizationOptions.md b/docs/TmsAuthorizationOptions.md new file mode 100644 index 00000000..d52d8789 --- /dev/null +++ b/docs/TmsAuthorizationOptions.md @@ -0,0 +1,10 @@ +# TmsAuthorizationOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**initiator** | [**TmsAuthorizationOptionsInitiator**](TmsAuthorizationOptionsInitiator.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/TmsAuthorizationOptionsInitiator.md b/docs/TmsAuthorizationOptionsInitiator.md new file mode 100644 index 00000000..9a2467bd --- /dev/null +++ b/docs/TmsAuthorizationOptionsInitiator.md @@ -0,0 +1,10 @@ +# TmsAuthorizationOptionsInitiator + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_initiated_transaction** | [**TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.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/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md new file mode 100644 index 00000000..ffdcf604 --- /dev/null +++ b/docs/TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md @@ -0,0 +1,11 @@ +# TmsAuthorizationOptionsInitiatorMerchantInitiatedTransaction + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previous_transaction_id** | **str** | 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. | [optional] +**original_authorized_amount** | **str** | Amount of the original authorization. | [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/TmsBinLookup.md b/docs/TmsBinLookup.md new file mode 100644 index 00000000..a86ea12f --- /dev/null +++ b/docs/TmsBinLookup.md @@ -0,0 +1,11 @@ +# TmsBinLookup + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_account_information** | [**TmsBinLookupPaymentAccountInformation**](TmsBinLookupPaymentAccountInformation.md) | | [optional] +**issuer_information** | [**TmsBinLookupIssuerInformation**](TmsBinLookupIssuerInformation.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/TmsBinLookupIssuerInformation.md b/docs/TmsBinLookupIssuerInformation.md new file mode 100644 index 00000000..647d3607 --- /dev/null +++ b/docs/TmsBinLookupIssuerInformation.md @@ -0,0 +1,14 @@ +# TmsBinLookupIssuerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | This field contains the issuer name. | [optional] +**country** | **str** | This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. | [optional] +**bin_length** | **str** | This field contains the length of the BIN. In some cases, this field may be absent if we do not receive accurate information from the network source. | [optional] +**account_prefix** | **str** | This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).In case the input is not the full intrument (PAN or TOKEN), this field may be truncated. | [optional] +**phone_number** | **str** | This field contains the customer service phone number for the issuer. | [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/TmsBinLookupPaymentAccountInformation.md b/docs/TmsBinLookupPaymentAccountInformation.md new file mode 100644 index 00000000..cd4c4287 --- /dev/null +++ b/docs/TmsBinLookupPaymentAccountInformation.md @@ -0,0 +1,12 @@ +# TmsBinLookupPaymentAccountInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**TmsBinLookupPaymentAccountInformationCard**](TmsBinLookupPaymentAccountInformationCard.md) | | [optional] +**features** | [**TmsBinLookupPaymentAccountInformationFeatures**](TmsBinLookupPaymentAccountInformationFeatures.md) | | [optional] +**network** | [**TmsBinLookupPaymentAccountInformationNetwork**](TmsBinLookupPaymentAccountInformationNetwork.md) | | [optional] + +[[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/TmsBinLookupPaymentAccountInformationCard.md b/docs/TmsBinLookupPaymentAccountInformationCard.md new file mode 100644 index 00000000..2d4d59b8 --- /dev/null +++ b/docs/TmsBinLookupPaymentAccountInformationCard.md @@ -0,0 +1,15 @@ +# TmsBinLookupPaymentAccountInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system. Possible values from BIN Lookup Service (based on availability and enablement): - `000`: Unsupported Card Type - `001`: Visa - `002`: Mastercard - `003`: American Express - `004`: Discover - `005`: Diners Club - `007`: JCB - `036`: Cartes Bancaire - `042`: Maestro - `054`: Elo - `058`: Carnet - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `064`: Prompt Card - `067`: Meeza - `068`: PayPak - `070`: EFTPOS - `081`: Jaywan - `082`: TPN Glossary of possible values in the payments ecosystem: - `001`: Visa - `002`: Mastercard - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche - `007`: JCB - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: EnRoute - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL - `023`: Disney Card - `024`: Switch/Solo - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron - `034`: Dankort - `035`: Laser - `036`: Cartes Bancaire - `037`: Carta Si - `040`: UATP - `041`: HOUSEHOLD - `042`: Maestro - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: J.Crew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo - `055`: Capital One Private Label - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: Meeza - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan - `082`: TPN | [optional] +**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - MADA - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS - MEEZA - PAYPAK - JAYWAN - TPN | [optional] +**currency** | **str** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional] +**max_length** | **str** | This field contains the max length of the card. | [optional] +**credential_type** | **str** | This field contains the type of the payment credential. Possible values: - PAN - TOKEN | [optional] +**brands** | [**list[TmsBinLookupPaymentAccountInformationCardBrands]**](TmsBinLookupPaymentAccountInformationCardBrands.md) | Array of brands | [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/TmsBinLookupPaymentAccountInformationCardBrands.md b/docs/TmsBinLookupPaymentAccountInformationCardBrands.md new file mode 100644 index 00000000..ca5c8ad9 --- /dev/null +++ b/docs/TmsBinLookupPaymentAccountInformationCardBrands.md @@ -0,0 +1,11 @@ +# TmsBinLookupPaymentAccountInformationCardBrands + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system. Possible values from BIN Lookup Service (based on availability and enablement): - `000`: Unsupported Card Type - `001`: Visa - `002`: Mastercard - `003`: American Express - `004`: Discover - `005`: Diners Club - `007`: JCB - `036`: Cartes Bancaire - `042`: Maestro - `054`: Elo - `058`: Carnet - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `064`: Prompt Card - `067`: Meeza - `068`: PayPak - `070`: EFTPOS - `081`: Jaywan - `082`: TPN Glossary of possible values in the payments ecosystem: - `001`: Visa - `002`: Mastercard - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche - `007`: JCB - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: EnRoute - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL - `023`: Disney Card - `024`: Switch/Solo - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron - `034`: Dankort - `035`: Laser - `036`: Cartes Bancaire - `037`: Carta Si - `040`: UATP - `041`: HOUSEHOLD - `042`: Maestro - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: J.Crew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo - `055`: Capital One Private Label - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: Meeza - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan - `082`: TPN | [optional] +**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - MADA - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS - MEEZA - PAYPAK - JAYWAN - TPN | [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/TmsBinLookupPaymentAccountInformationFeatures.md b/docs/TmsBinLookupPaymentAccountInformationFeatures.md new file mode 100644 index 00000000..9381bdf4 --- /dev/null +++ b/docs/TmsBinLookupPaymentAccountInformationFeatures.md @@ -0,0 +1,28 @@ +# TmsBinLookupPaymentAccountInformationFeatures + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_funding_source** | **str** | This field contains the account funding source. Possible values: - `CREDIT` - `DEBIT` - `PREPAID` - `DEFERRED DEBIT` - `CHARGE` | [optional] +**account_funding_source_sub_type** | **str** | This field contains the type of prepaid card. Possible values: - `Reloadable` - `Non-reloadable` | [optional] +**card_product** | **str** | This field contains the type of issuer product. Example values: - Visa Classic - Visa Signature - Visa Infinite | [optional] +**message_type** | **str** | This field contains the type of BIN based authentication. Possible values: - `S`: Single Message - `D`: Dual Message | [optional] +**acceptance_level** | **str** | This field contains the acceptance level of the PAN. Possible values: - `0` : Normal - `1` : Monitor - `2` : Refuse - `3` : Not Allowed - `4` : Private - `5` : Test | [optional] +**card_platform** | **str** | This field contains the type of card platform. Possible values: - `BUSINESS` - `CONSUMER` - `CORPORATE` - `COMMERCIAL` - `GOVERNMENT` | [optional] +**combo_card** | **str** | This field indicates the type of combo card. Possible values: - 0 (Not a combo card) - 1 (Credit and Prepaid Combo card) - 2 (Credit and Debit Combo card) - 3 (Prepaid Credit and Prepaid Debit combo card) | [optional] +**corporate_purchase** | **bool** | This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards. Possible values: - `true` - `false` | [optional] +**health_card** | **bool** | This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs. Possible values: - `true` - `false` | [optional] +**shared_bin** | **bool** | This field indicates if the BIN is shared by multiple issuers Possible values: - `true` - `false` | [optional] +**pos_domestic_only** | **bool** | This field indicates if the BIN is valid only for POS domestic usage. Possible values: - `true` - `false` | [optional] +**gambling_allowed** | **bool** | This field indicates if gambling transactions are allowed on the BIN. Possible values: - `true` - `false` | [optional] +**commercial_card_level2** | **bool** | This field indicates if a transaction on the instrument qualifies for level 2 interchange rates. Possible values: - `true` - `false` | [optional] +**commercial_card_level3** | **bool** | This field indicates if a transaction on the instrument qualifies for level 3 interchange rates. Possible values: - `true` - `false` | [optional] +**exempt_bin** | **bool** | This field indicates if a transaction on the instrument qualifies for government exempt interchange fee. Possible values: - `true` - `false` | [optional] +**account_level_management** | **bool** | This field indicates if the BIN participates in Account Level Management (ALM). Possible values: - `true` - `false` | [optional] +**online_gambling_block** | **bool** | This field indicates if online gambling is blocked on the BIN. Possible values: - `true` - `false` | [optional] +**auto_substantiation** | **bool** | This field indicates if auto-substantiation is enabled on the BIN. Possible values: - `true` - `false` | [optional] +**flex_credential** | **bool** | This field indicates if the instrument is a flex credential. Possible values: - `true` - `false` | [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/TmsBinLookupPaymentAccountInformationNetwork.md b/docs/TmsBinLookupPaymentAccountInformationNetwork.md new file mode 100644 index 00000000..7a0edf96 --- /dev/null +++ b/docs/TmsBinLookupPaymentAccountInformationNetwork.md @@ -0,0 +1,10 @@ +# TmsBinLookupPaymentAccountInformationNetwork + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | This field contains a code that identifies the network. [List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_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/TmsBusinessInformation.md b/docs/TmsBusinessInformation.md new file mode 100644 index 00000000..cafd1cdd --- /dev/null +++ b/docs/TmsBusinessInformation.md @@ -0,0 +1,16 @@ +# TmsBusinessInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the network token merchant. | [optional] +**doing_business_as** | **str** | Name the network token merchant does business as | [optional] +**address** | [**TmsBusinessInformationAddress**](TmsBusinessInformationAddress.md) | | [optional] +**website_url** | **str** | Website of network token merchant. | [optional] +**business_identification_type** | **str** | The Identifier associated with the business type; required unless both acquirerId and acquirerMerchantId are provided. | [optional] +**business_identification_value** | **str** | The value associated with the business identifier type; required unless both acquirerId and acquirerMerchantId are provided. | [optional] +**acquirer** | [**TmsBusinessInformationAcquirer**](TmsBusinessInformationAcquirer.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/TmsBusinessInformationAcquirer.md b/docs/TmsBusinessInformationAcquirer.md new file mode 100644 index 00000000..7424c2dc --- /dev/null +++ b/docs/TmsBusinessInformationAcquirer.md @@ -0,0 +1,11 @@ +# TmsBusinessInformationAcquirer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acquirer_id** | **str** | Acquirer ID; required unless both businessIdentificationType and businessIdentificationValue are provided. | [optional] +**acquirer_merchant_id** | **str** | Acquirer merchant ID; required unless both businessIdentificationType and businessIdentificationValue are provided. | [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/TmsBusinessInformationAddress.md b/docs/TmsBusinessInformationAddress.md new file mode 100644 index 00000000..0f9b13dc --- /dev/null +++ b/docs/TmsBusinessInformationAddress.md @@ -0,0 +1,11 @@ +# TmsBusinessInformationAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country** | **str** | Country of network token merchant. | [optional] +**locality** | **str** | City of network token merchant. | [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/TmsCardArt.md b/docs/TmsCardArt.md new file mode 100644 index 00000000..ec919d38 --- /dev/null +++ b/docs/TmsCardArt.md @@ -0,0 +1,14 @@ +# TmsCardArt + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**foreground_color** | **str** | Card foreground color. | [optional] +**combined_asset** | [**TmsCardArtCombinedAsset**](TmsCardArtCombinedAsset.md) | | [optional] +**brand_logo_asset** | [**TmsCardArtBrandLogoAsset**](TmsCardArtBrandLogoAsset.md) | | [optional] +**issuer_logo_asset** | [**TmsCardArtIssuerLogoAsset**](TmsCardArtIssuerLogoAsset.md) | | [optional] +**icon_asset** | [**TmsCardArtIconAsset**](TmsCardArtIconAsset.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/TmsCardArtBrandLogoAsset.md b/docs/TmsCardArtBrandLogoAsset.md new file mode 100644 index 00000000..a51ed7c0 --- /dev/null +++ b/docs/TmsCardArtBrandLogoAsset.md @@ -0,0 +1,11 @@ +# TmsCardArtBrandLogoAsset + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the asset | [optional] +**links** | [**TmsCardArtBrandLogoAssetLinks**](TmsCardArtBrandLogoAssetLinks.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/TmsCardArtBrandLogoAssetLinks.md b/docs/TmsCardArtBrandLogoAssetLinks.md new file mode 100644 index 00000000..bace1a5e --- /dev/null +++ b/docs/TmsCardArtBrandLogoAssetLinks.md @@ -0,0 +1,10 @@ +# TmsCardArtBrandLogoAssetLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**TmsCardArtBrandLogoAssetLinksSelf**](TmsCardArtBrandLogoAssetLinksSelf.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/TmsCardArtBrandLogoAssetLinksSelf.md b/docs/TmsCardArtBrandLogoAssetLinksSelf.md new file mode 100644 index 00000000..4b5b348d --- /dev/null +++ b/docs/TmsCardArtBrandLogoAssetLinksSelf.md @@ -0,0 +1,10 @@ +# TmsCardArtBrandLogoAssetLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo' | [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/TmsCardArtCombinedAsset.md b/docs/TmsCardArtCombinedAsset.md new file mode 100644 index 00000000..54f25659 --- /dev/null +++ b/docs/TmsCardArtCombinedAsset.md @@ -0,0 +1,11 @@ +# TmsCardArtCombinedAsset + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the asset | [optional] +**links** | [**TmsCardArtCombinedAssetLinks**](TmsCardArtCombinedAssetLinks.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/TmsCardArtCombinedAssetLinks.md b/docs/TmsCardArtCombinedAssetLinks.md new file mode 100644 index 00000000..ea9fe52a --- /dev/null +++ b/docs/TmsCardArtCombinedAssetLinks.md @@ -0,0 +1,10 @@ +# TmsCardArtCombinedAssetLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**TmsCardArtCombinedAssetLinksSelf**](TmsCardArtCombinedAssetLinksSelf.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/TmsCardArtCombinedAssetLinksSelf.md b/docs/TmsCardArtCombinedAssetLinksSelf.md new file mode 100644 index 00000000..46abe373 --- /dev/null +++ b/docs/TmsCardArtCombinedAssetLinksSelf.md @@ -0,0 +1,10 @@ +# TmsCardArtCombinedAssetLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined' | [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/TmsCardArtIconAsset.md b/docs/TmsCardArtIconAsset.md new file mode 100644 index 00000000..574d1449 --- /dev/null +++ b/docs/TmsCardArtIconAsset.md @@ -0,0 +1,11 @@ +# TmsCardArtIconAsset + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the asset | [optional] +**links** | [**TmsCardArtIconAssetLinks**](TmsCardArtIconAssetLinks.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/TmsCardArtIconAssetLinks.md b/docs/TmsCardArtIconAssetLinks.md new file mode 100644 index 00000000..f8b8d59b --- /dev/null +++ b/docs/TmsCardArtIconAssetLinks.md @@ -0,0 +1,10 @@ +# TmsCardArtIconAssetLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**TmsCardArtIconAssetLinksSelf**](TmsCardArtIconAssetLinksSelf.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/TmsCardArtIconAssetLinksSelf.md b/docs/TmsCardArtIconAssetLinksSelf.md new file mode 100644 index 00000000..6074bef4 --- /dev/null +++ b/docs/TmsCardArtIconAssetLinksSelf.md @@ -0,0 +1,10 @@ +# TmsCardArtIconAssetLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/icon' | [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/TmsCardArtIssuerLogoAsset.md b/docs/TmsCardArtIssuerLogoAsset.md new file mode 100644 index 00000000..2394b6f5 --- /dev/null +++ b/docs/TmsCardArtIssuerLogoAsset.md @@ -0,0 +1,11 @@ +# TmsCardArtIssuerLogoAsset + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the asset | [optional] +**links** | [**TmsCardArtIssuerLogoAssetLinks**](TmsCardArtIssuerLogoAssetLinks.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/TmsCardArtIssuerLogoAssetLinks.md b/docs/TmsCardArtIssuerLogoAssetLinks.md new file mode 100644 index 00000000..7e91b4c6 --- /dev/null +++ b/docs/TmsCardArtIssuerLogoAssetLinks.md @@ -0,0 +1,10 @@ +# TmsCardArtIssuerLogoAssetLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**TmsCardArtIssuerLogoAssetLinksSelf**](TmsCardArtIssuerLogoAssetLinksSelf.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/TmsCardArtIssuerLogoAssetLinksSelf.md b/docs/TmsCardArtIssuerLogoAssetLinksSelf.md new file mode 100644 index 00000000..84781f5b --- /dev/null +++ b/docs/TmsCardArtIssuerLogoAssetLinksSelf.md @@ -0,0 +1,10 @@ +# TmsCardArtIssuerLogoAssetLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo' | [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/TmsEmbeddedInstrumentIdentifier.md b/docs/TmsEmbeddedInstrumentIdentifier.md new file mode 100644 index 00000000..467e2c40 --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifier.md @@ -0,0 +1,23 @@ +# TmsEmbeddedInstrumentIdentifier + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**TmsEmbeddedInstrumentIdentifierLinks**](TmsEmbeddedInstrumentIdentifierLinks.md) | | [optional] +**id** | **str** | The Id of the Instrument Identifier Token. | [optional] +**object** | **str** | The type. Possible Values: - instrumentIdentifier | [optional] +**state** | **str** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] +**type** | **str** | The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token | [optional] +**token_provisioning_information** | [**Ptsv2paymentsTokenInformationTokenProvisioningInformation**](Ptsv2paymentsTokenInformationTokenProvisioningInformation.md) | | [optional] +**card** | [**TmsEmbeddedInstrumentIdentifierCard**](TmsEmbeddedInstrumentIdentifierCard.md) | | [optional] +**bank_account** | [**TmsEmbeddedInstrumentIdentifierBankAccount**](TmsEmbeddedInstrumentIdentifierBankAccount.md) | | [optional] +**tokenized_card** | [**Tmsv2TokenizedCard**](Tmsv2TokenizedCard.md) | | [optional] +**issuer** | [**TmsEmbeddedInstrumentIdentifierIssuer**](TmsEmbeddedInstrumentIdentifierIssuer.md) | | [optional] +**processing_information** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional] +**bill_to** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional] +**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional] +**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.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/TmsEmbeddedInstrumentIdentifierBankAccount.md b/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md new file mode 100644 index 00000000..e7fe977a --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md @@ -0,0 +1,11 @@ +# TmsEmbeddedInstrumentIdentifierBankAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **str** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] +**routing_number** | **str** | 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] + +[[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/TmsEmbeddedInstrumentIdentifierBillTo.md b/docs/TmsEmbeddedInstrumentIdentifierBillTo.md new file mode 100644 index 00000000..2bec3541 --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierBillTo.md @@ -0,0 +1,15 @@ +# TmsEmbeddedInstrumentIdentifierBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] +**address2** | **str** | Additional address information. | [optional] +**locality** | **str** | Payment card billing city. | [optional] +**administrative_area** | **str** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] +**postal_code** | **str** | 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` | [optional] +**country** | **str** | Payment card billing country. Use the two-character ISO Standard Country Codes. | [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/TmsEmbeddedInstrumentIdentifierCard.md b/docs/TmsEmbeddedInstrumentIdentifierCard.md new file mode 100644 index 00000000..2b9b66aa --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierCard.md @@ -0,0 +1,13 @@ +# TmsEmbeddedInstrumentIdentifierCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. | [optional] +**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] +**expiration_year** | **str** | Four-digit year in which the credit card expires. Format: `YYYY`. | [optional] +**security_code** | **str** | Card Verification Code. This value is sent to the issuer to support the approval of a network token provision. It is not persisted against the Instrument Identifier. | [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/TmsEmbeddedInstrumentIdentifierEmbedded.md b/docs/TmsEmbeddedInstrumentIdentifierEmbedded.md new file mode 100644 index 00000000..a93e3eb4 --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierEmbedded.md @@ -0,0 +1,10 @@ +# TmsEmbeddedInstrumentIdentifierEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bin_lookup** | [**TmsBinLookup**](TmsBinLookup.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/TmsEmbeddedInstrumentIdentifierIssuer.md b/docs/TmsEmbeddedInstrumentIdentifierIssuer.md new file mode 100644 index 00000000..645e5b78 --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierIssuer.md @@ -0,0 +1,10 @@ +# TmsEmbeddedInstrumentIdentifierIssuer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_account_reference** | **str** | This reference number serves as a link to the cardholder account and to all transactions for that 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/TmsEmbeddedInstrumentIdentifierLinks.md b/docs/TmsEmbeddedInstrumentIdentifierLinks.md new file mode 100644 index 00000000..0a9d3dd1 --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierLinks.md @@ -0,0 +1,11 @@ +# TmsEmbeddedInstrumentIdentifierLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**TmsEmbeddedInstrumentIdentifierLinksSelf**](TmsEmbeddedInstrumentIdentifierLinksSelf.md) | | [optional] +**payment_instruments** | [**TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments**](TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.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/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.md b/docs/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.md new file mode 100644 index 00000000..67ffa7e3 --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments.md @@ -0,0 +1,10 @@ +# TmsEmbeddedInstrumentIdentifierLinksPaymentInstruments + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Instrument Identifiers Payment Instruments. | [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/TmsEmbeddedInstrumentIdentifierLinksSelf.md b/docs/TmsEmbeddedInstrumentIdentifierLinksSelf.md new file mode 100644 index 00000000..da1ceeb9 --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierLinksSelf.md @@ -0,0 +1,10 @@ +# TmsEmbeddedInstrumentIdentifierLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Instrument Identifier. | [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/TmsEmbeddedInstrumentIdentifierMetadata.md b/docs/TmsEmbeddedInstrumentIdentifierMetadata.md new file mode 100644 index 00000000..3da96b5b --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierMetadata.md @@ -0,0 +1,10 @@ +# TmsEmbeddedInstrumentIdentifierMetadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**creator** | **str** | The creator of the Instrument Identifier. | [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/TmsEmbeddedInstrumentIdentifierProcessingInformation.md b/docs/TmsEmbeddedInstrumentIdentifierProcessingInformation.md new file mode 100644 index 00000000..90317def --- /dev/null +++ b/docs/TmsEmbeddedInstrumentIdentifierProcessingInformation.md @@ -0,0 +1,10 @@ +# TmsEmbeddedInstrumentIdentifierProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authorization_options** | [**TmsAuthorizationOptions**](TmsAuthorizationOptions.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/TmsNetworkTokenServices.md b/docs/TmsNetworkTokenServices.md new file mode 100644 index 00000000..6bb9e335 --- /dev/null +++ b/docs/TmsNetworkTokenServices.md @@ -0,0 +1,15 @@ +# TmsNetworkTokenServices + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notifications** | [**TmsNetworkTokenServicesNotifications**](TmsNetworkTokenServicesNotifications.md) | | [optional] +**payment_credentials** | [**TmsNetworkTokenServicesPaymentCredentials**](TmsNetworkTokenServicesPaymentCredentials.md) | | [optional] +**synchronous_provisioning** | [**TmsNetworkTokenServicesSynchronousProvisioning**](TmsNetworkTokenServicesSynchronousProvisioning.md) | | [optional] +**visa_token_service** | [**TmsNetworkTokenServicesVisaTokenService**](TmsNetworkTokenServicesVisaTokenService.md) | | [optional] +**mastercard_digital_enablement_service** | [**TmsNetworkTokenServicesMastercardDigitalEnablementService**](TmsNetworkTokenServicesMastercardDigitalEnablementService.md) | | [optional] +**american_express_token_service** | [**TmsNetworkTokenServicesAmericanExpressTokenService**](TmsNetworkTokenServicesAmericanExpressTokenService.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/TmsNetworkTokenServicesAmericanExpressTokenService.md b/docs/TmsNetworkTokenServicesAmericanExpressTokenService.md new file mode 100644 index 00000000..0536c0c7 --- /dev/null +++ b/docs/TmsNetworkTokenServicesAmericanExpressTokenService.md @@ -0,0 +1,13 @@ +# TmsNetworkTokenServicesAmericanExpressTokenService + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enable_service** | **bool** | Indicates if the service for network tokens for the American Express card association are enabled | [optional] +**enable_transactional_tokens** | **bool** | Indicates if network tokens for the American Express card association are enabled for transactions | [optional] +**token_requestor_id** | **str** | Token Requestor ID provided by American Express during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"12345678912\" | [optional] +**se_number** | **str** | SE Number assigned by American Express for the merchant's account Pattern: \"^[0-9]{11}\\\\z$\" Min Length: 10 Max Length: 10 Example: \"9876543212\" | [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/TmsNetworkTokenServicesMastercardDigitalEnablementService.md b/docs/TmsNetworkTokenServicesMastercardDigitalEnablementService.md new file mode 100644 index 00000000..8b4bb806 --- /dev/null +++ b/docs/TmsNetworkTokenServicesMastercardDigitalEnablementService.md @@ -0,0 +1,12 @@ +# TmsNetworkTokenServicesMastercardDigitalEnablementService + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enable_service** | **bool** | Indicates if the service for network tokens for the Mastercard card association are enabled | [optional] +**enable_transactional_tokens** | **bool** | Indicates if network tokens for the Mastercard card association are enabled for transactions | [optional] +**token_requestor_id** | **str** | Token Requestor ID provided by Mastercard during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"50162233570\" | [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/TmsNetworkTokenServicesNotifications.md b/docs/TmsNetworkTokenServicesNotifications.md new file mode 100644 index 00000000..7e5818a6 --- /dev/null +++ b/docs/TmsNetworkTokenServicesNotifications.md @@ -0,0 +1,10 @@ +# TmsNetworkTokenServicesNotifications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Indicates if lifecycle management (LCM) notifications are enabled | [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/TmsNetworkTokenServicesPaymentCredentials.md b/docs/TmsNetworkTokenServicesPaymentCredentials.md new file mode 100644 index 00000000..d739ffdd --- /dev/null +++ b/docs/TmsNetworkTokenServicesPaymentCredentials.md @@ -0,0 +1,10 @@ +# TmsNetworkTokenServicesPaymentCredentials + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Indicates if Payment Credentials are enabled. If enabled, this provides access to the unredacted token and its associated cryptogram. | [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/TmsNetworkTokenServicesSynchronousProvisioning.md b/docs/TmsNetworkTokenServicesSynchronousProvisioning.md new file mode 100644 index 00000000..b5a07b45 --- /dev/null +++ b/docs/TmsNetworkTokenServicesSynchronousProvisioning.md @@ -0,0 +1,10 @@ +# TmsNetworkTokenServicesSynchronousProvisioning + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Indicates if network tokens are provisioned synchronously (i.e. as part of the transaction flow) or asychronously (i.e. in parallel to the payment flow) NOTE: The synchronous provisioning feature is designed exclusively for aggregator merchants. Direct merchants should not enable synchronous provisioning as TMS manages the asynchronous creation of network tokens for direct clients. Activation of this feature by direct merchants will lead to latency in the authorization response. | [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/TmsNetworkTokenServicesVisaTokenService.md b/docs/TmsNetworkTokenServicesVisaTokenService.md new file mode 100644 index 00000000..7e2f5617 --- /dev/null +++ b/docs/TmsNetworkTokenServicesVisaTokenService.md @@ -0,0 +1,13 @@ +# TmsNetworkTokenServicesVisaTokenService + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enable_service** | **bool** | Indicates if the service for network tokens for the Visa card association are enabled | [optional] +**enable_transactional_tokens** | **bool** | Indicates if network tokens for the Visa card association are enabled for transactions | [optional] +**token_requestor_id** | **str** | Token Requestor ID provided by Visa during the registration process for the Tokenization Service Pattern: ^[0-9]{11}\\\\z$\" Min Length: 11 Max Length: 11 Example: \"40000000082\" | [optional] +**relationship_id** | **str** | Relationship ID provided by visa Min Length: 1 Max Length: 100 Example: \"24681921-40000000082\" | [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/TmsNullify.md b/docs/TmsNullify.md new file mode 100644 index 00000000..3ed9c0e1 --- /dev/null +++ b/docs/TmsNullify.md @@ -0,0 +1,12 @@ +# TmsNullify + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**instrument_identifier_card_number** | **bool** | Indicates if the card number should be nullified (i.e. not stored) | [optional] +**instrument_identifier_card_expiration** | **bool** | Indicates if the expiration date associated to the instrument identifier should be nullified (i.e. not stored) | [optional] +**payment_instrument_card_details** | **bool** | Indicates if the card details should be nullified (i.e. not stored) | [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/TmsPaymentInstrumentProcessingInfo.md b/docs/TmsPaymentInstrumentProcessingInfo.md new file mode 100644 index 00000000..9d46c80e --- /dev/null +++ b/docs/TmsPaymentInstrumentProcessingInfo.md @@ -0,0 +1,11 @@ +# TmsPaymentInstrumentProcessingInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bill_payment_program_enabled** | **bool** | Flag that indicates that this is a payment for a bill or for an existing contractual loan. Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. # For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**bank_transfer_options** | [**TmsPaymentInstrumentProcessingInfoBankTransferOptions**](TmsPaymentInstrumentProcessingInfoBankTransferOptions.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/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md b/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md new file mode 100644 index 00000000..a4d6e39b --- /dev/null +++ b/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md @@ -0,0 +1,10 @@ +# TmsPaymentInstrumentProcessingInfoBankTransferOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sec_code** | **str** | Specifies the authorization method for the transaction. #### TeleCheck Possible Values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry # For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] + +[[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/TmsSensitivePrivileges.md b/docs/TmsSensitivePrivileges.md new file mode 100644 index 00000000..0e2e8f5e --- /dev/null +++ b/docs/TmsSensitivePrivileges.md @@ -0,0 +1,10 @@ +# TmsSensitivePrivileges + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_number_masking_format** | **str** | Indicates which digits of the card number will be unmasked. Possible Values: - 'FIRST_6_LAST_4' - 'LAST_4' - 'MASKED' | [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/TmsTokenFormats.md b/docs/TmsTokenFormats.md new file mode 100644 index 00000000..2108f8db --- /dev/null +++ b/docs/TmsTokenFormats.md @@ -0,0 +1,13 @@ +# TmsTokenFormats + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer** | **str** | Format for customer tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [optional] +**payment_instrument** | **str** | Format for payment instrument tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [optional] +**instrument_identifier_card** | **str** | Format for card based instrument identifier tokens. Possible Values: - '16_DIGIT' - '16_DIGIT_LAST_4' - '19_DIGIT' - '19_DIGIT_LAST_4' - '22_DIGIT' - '32_HEX' | [optional] +**instrument_identifier_bank_account** | **str** | Format for bank account based instrument identifier tokens. Possible Values: - '16_DIGIT' - '19_DIGIT' - '22_DIGIT' - '32_HEX' | [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/Tmsv2TokenizedCard.md b/docs/Tmsv2TokenizedCard.md new file mode 100644 index 00000000..34ddbd90 --- /dev/null +++ b/docs/Tmsv2TokenizedCard.md @@ -0,0 +1,32 @@ +# Tmsv2TokenizedCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Tmsv2TokenizedCardLinks**](Tmsv2TokenizedCardLinks.md) | | [optional] +**id** | **str** | The Id of the Tokenized Card. | [optional] +**object** | **str** | The type. Possible Values: - tokenizedCard | [optional] +**account_reference_id** | **str** | An identifier provided by the issuer for the account. | [optional] +**consumer_id** | **str** | Identifier of the consumer within the wallet. Maximum 24 characters for VTS. | [optional] +**create_instrument_identifier** | **bool** | Specifies whether the InstrumentId should be created (true) or not (false). Possible Values: - `true`: The InstrumentId should be created. - `false`: The InstrumentId should be created. | [optional] +**source** | **str** | Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER | [optional] +**state** | **str** | State of the network token or network token provision. Possible Values: ACTIVE : Network token is active. SUSPENDED : Network token is suspended. This state can change back to ACTIVE. DELETED : This is a final state for a network token instance. UNPROVISIONED : A previous network token. | [optional] +**reason** | **str** | Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration. | [optional] +**number** | **str** | The token requestor's network token for the provided PAN and consumer Id, if available. | [optional] +**expiration_month** | **str** | Two-digit month in which the network token expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] +**expiration_year** | **str** | Four-digit year in which the network token expires. Format: `YYYY`. | [optional] +**type** | **str** | The type of card (Card Network). Possible Values: - visa - mastercard - americanexpress | [optional] +**cryptogram** | **str** | Value generated by the card association to be used alongside the network token for processing a payment. | [optional] +**security_code** | **str** | 4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF. | [optional] +**eci** | **str** | Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication. | [optional] +**requestor_id** | **str** | 11-digit identifier that uniquely identifies the Token Requestor. | [optional] +**enrollment_id** | **str** | Unique id to identify this PAN/ enrollment. | [optional] +**token_reference_id** | **str** | Unique ID for netwrok token. | [optional] +**payment_account_reference** | **str** | Payment account reference. | [optional] +**card** | [**Tmsv2TokenizedCardCard**](Tmsv2TokenizedCardCard.md) | | [optional] +**passcode** | [**Tmsv2TokenizedCardPasscode**](Tmsv2TokenizedCardPasscode.md) | | [optional] +**metadata** | [**Tmsv2TokenizedCardMetadata**](Tmsv2TokenizedCardMetadata.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/Tmsv2TokenizedCardCard.md b/docs/Tmsv2TokenizedCardCard.md new file mode 100644 index 00000000..58d0875a --- /dev/null +++ b/docs/Tmsv2TokenizedCardCard.md @@ -0,0 +1,14 @@ +# Tmsv2TokenizedCardCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). | [optional] +**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] +**expiration_year** | **str** | Four-digit year in which the credit card expires. Format: `YYYY`. | [optional] +**type** | **str** | The type of card (Card Network). Possible Values: - 001: visa | [optional] +**suffix** | **str** | The customer's latest payment card number suffix. | [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/Tmsv2TokenizedCardLinks.md b/docs/Tmsv2TokenizedCardLinks.md new file mode 100644 index 00000000..06498123 --- /dev/null +++ b/docs/Tmsv2TokenizedCardLinks.md @@ -0,0 +1,10 @@ +# Tmsv2TokenizedCardLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Tmsv2TokenizedCardLinksSelf**](Tmsv2TokenizedCardLinksSelf.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/Tmsv2TokenizedCardLinksSelf.md b/docs/Tmsv2TokenizedCardLinksSelf.md new file mode 100644 index 00000000..54bcc484 --- /dev/null +++ b/docs/Tmsv2TokenizedCardLinksSelf.md @@ -0,0 +1,10 @@ +# Tmsv2TokenizedCardLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Tokenized Card. example: 'tms/v2/tokenized-cards/7010000000016241111' | [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/Tmsv2TokenizedCardMetadata.md b/docs/Tmsv2TokenizedCardMetadata.md new file mode 100644 index 00000000..b39ac97a --- /dev/null +++ b/docs/Tmsv2TokenizedCardMetadata.md @@ -0,0 +1,11 @@ +# Tmsv2TokenizedCardMetadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_art** | [**TmsCardArt**](TmsCardArt.md) | | [optional] +**issuer** | [**Tmsv2TokenizedCardMetadataIssuer**](Tmsv2TokenizedCardMetadataIssuer.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/Tmsv2TokenizedCardMetadataIssuer.md b/docs/Tmsv2TokenizedCardMetadataIssuer.md new file mode 100644 index 00000000..687de185 --- /dev/null +++ b/docs/Tmsv2TokenizedCardMetadataIssuer.md @@ -0,0 +1,12 @@ +# Tmsv2TokenizedCardMetadataIssuer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | issuer name. | [optional] +**short_description** | **str** | issuer short description. | [optional] +**long_description** | **str** | issuer long description. | [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/Tmsv2TokenizedCardPasscode.md b/docs/Tmsv2TokenizedCardPasscode.md new file mode 100644 index 00000000..de179909 --- /dev/null +++ b/docs/Tmsv2TokenizedCardPasscode.md @@ -0,0 +1,10 @@ +# Tmsv2TokenizedCardPasscode + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | OTP generated at issuer. | [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/Tmsv2customersBuyerInformation.md b/docs/Tmsv2customersBuyerInformation.md new file mode 100644 index 00000000..cf57c3da --- /dev/null +++ b/docs/Tmsv2customersBuyerInformation.md @@ -0,0 +1,11 @@ +# Tmsv2customersBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_customer_id** | **str** | Your identifier for the customer. | [optional] +**email** | **str** | Customer's primary email address, including the full domain name. | [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/Tmsv2customersClientReferenceInformation.md b/docs/Tmsv2customersClientReferenceInformation.md new file mode 100644 index 00000000..7290a585 --- /dev/null +++ b/docs/Tmsv2customersClientReferenceInformation.md @@ -0,0 +1,10 @@ +# Tmsv2customersClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Client-generated order reference or tracking number. | [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/Tmsv2customersDefaultPaymentInstrument.md b/docs/Tmsv2customersDefaultPaymentInstrument.md new file mode 100644 index 00000000..961de0cc --- /dev/null +++ b/docs/Tmsv2customersDefaultPaymentInstrument.md @@ -0,0 +1,10 @@ +# Tmsv2customersDefaultPaymentInstrument + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The Id of the Customers default Payment Instrument | [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/Tmsv2customersDefaultShippingAddress.md b/docs/Tmsv2customersDefaultShippingAddress.md new file mode 100644 index 00000000..ed713253 --- /dev/null +++ b/docs/Tmsv2customersDefaultShippingAddress.md @@ -0,0 +1,10 @@ +# Tmsv2customersDefaultShippingAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The Id of the Customers default Shipping 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/Tmsv2customersEmbedded.md b/docs/Tmsv2customersEmbedded.md new file mode 100644 index 00000000..fbea8aa1 --- /dev/null +++ b/docs/Tmsv2customersEmbedded.md @@ -0,0 +1,11 @@ +# Tmsv2customersEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**default_payment_instrument** | [**Tmsv2customersEmbeddedDefaultPaymentInstrument**](Tmsv2customersEmbeddedDefaultPaymentInstrument.md) | | [optional] +**default_shipping_address** | [**Tmsv2customersEmbeddedDefaultShippingAddress**](Tmsv2customersEmbeddedDefaultShippingAddress.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/Tmsv2customersEmbeddedDefaultPaymentInstrument.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrument.md new file mode 100644 index 00000000..5c103fbc --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrument.md @@ -0,0 +1,24 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrument + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] +**id** | **str** | The Id of the Payment Instrument Token. | [optional] +**object** | **str** | The type. Possible Values: - paymentInstrument | [optional] +**default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] +**state** | **str** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] +**type** | **str** | The type of Payment Instrument. Possible Values: - cardHash | [optional] +**bank_account** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] +**card** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] +**buyer_information** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] +**bill_to** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] +**processing_information** | [**TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] +**merchant_information** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md) | | [optional] +**instrument_identifier** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] +**metadata** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] +**embedded** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md new file mode 100644 index 00000000..439773fd --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Account type. Possible Values: - checking : C - general ledger : G This value is supported only on Wells Fargo ACH - savings : S (U.S. dollars only) - corporate checking : X (U.S. dollars 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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md new file mode 100644 index 00000000..a3bc5fcb --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md @@ -0,0 +1,20 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | Customer's first name. This name must be the same as the name on the card. | [optional] +**last_name** | **str** | Customer's last name. This name must be the same as the name on the card. | [optional] +**company** | **str** | Name of the customer's company. | [optional] +**address1** | **str** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] +**address2** | **str** | Additional address information. | [optional] +**locality** | **str** | Payment card billing city. | [optional] +**administrative_area** | **str** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] +**postal_code** | **str** | 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` | [optional] +**country** | **str** | Payment card billing country. Use the two-character ISO Standard Country Codes. | [optional] +**email** | **str** | Customer's email address, including the full domain name. | [optional] +**phone_number** | **str** | Customer's phone number. | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md new file mode 100644 index 00000000..cad284d8 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md @@ -0,0 +1,13 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**company_tax_id** | **str** | Company's tax identifier. This is only used for eCheck service. | [optional] +**currency** | **str** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). # For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**date_of_birth** | **date** | Date of birth of the customer. Format: YYYY-MM-DD | [optional] +**personal_identification** | [**list[Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification]**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md new file mode 100644 index 00000000..b064e509 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**administrative_area** | **str** | The State or province where the customer's driver's license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada. | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md new file mode 100644 index 00000000..25a33702 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md @@ -0,0 +1,12 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The value of the identification type. | [optional] +**type** | **str** | The type of the identification. Possible Values: - driver license | [optional] +**issued_by** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md new file mode 100644 index 00000000..1a0e3228 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md @@ -0,0 +1,18 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] +**expiration_year** | **str** | Four-digit year in which the credit card expires. Format: `YYYY`. | [optional] +**type** | **str** | Value that indicates the card type. Possible Values v2 : v1: * 001 : visa * 002 : mastercard - Eurocard—European regional brand of Mastercard * 003 : american express * 004 : discover * 005 : diners club * 006 : carte blanche * 007 : jcb * 008 : optima * 011 : twinpay credit * 012 : twinpay debit * 013 : walmart * 014 : enRoute * 015 : lowes consumer * 016 : home depot consumer * 017 : mbna * 018 : dicks sportswear * 019 : casual corner * 020 : sears * 021 : jal * 023 : disney * 024 : maestro uk domestic * 025 : sams club consumer * 026 : sams club business * 028 : bill me later * 029 : bebe * 030 : restoration hardware * 031 : delta online — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * 032 : solo * 033 : visa electron * 034 : dankort * 035 : laser * 036 : carte bleue — formerly Cartes Bancaires * 037 : carta si * 038 : pinless debit * 039 : encoded account * 040 : uatp * 041 : household * 042 : maestro international * 043 : ge money uk * 044 : korean cards * 045 : style * 046 : jcrew * 047 : payease china processing ewallet * 048 : payease china processing bank transfer * 049 : meijer private label * 050 : hipercard — supported only by the Comercio Latino processor. * 051 : aura — supported only by the Comercio Latino processor. * 052 : redecard * 054 : elo — supported only by the Comercio Latino processor. * 055 : capital one private label * 056 : synchrony private label * 057 : costco private label * 060 : mada * 062 : china union pay * 063 : falabella private label | [optional] +**issue_number** | **str** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. | [optional] +**start_month** | **str** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible Values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] +**start_year** | **str** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] +**use_as** | **str** | 'Payment Instrument was created / updated as part of a pinless debit transaction.' | [optional] +**hash** | **str** | Hash value representing the card. | [optional] +**tokenized_information** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md new file mode 100644 index 00000000..74447adb --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md @@ -0,0 +1,11 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestor_id** | **str** | Value that identifies your business and indicates that the cardholder's account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider's database. **Note** This field is supported only through **VisaNet** and **FDC Nashville Global**. | [optional] +**transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Set the value for this field to 1. An application on the customer's mobile device provided the token data. | [optional] + +[[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/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md new file mode 100644 index 00000000..13368f03 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**instrument_identifier** | [**TmsEmbeddedInstrumentIdentifier**](TmsEmbeddedInstrumentIdentifier.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md new file mode 100644 index 00000000..e1f8d02e --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The Id of the Instrument Identifier linked to the Payment Instrument. | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md new file mode 100644 index 00000000..0c3ddad8 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md @@ -0,0 +1,11 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md) | | [optional] +**customer** | [**Tmsv2customersLinksSelf**](Tmsv2customersLinksSelf.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md new file mode 100644 index 00000000..379168fe --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Payment Instrument. | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md new file mode 100644 index 00000000..0bf1a437 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_descriptor** | [**Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.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/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md new file mode 100644 index 00000000..d03ed57c --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alternate_name** | **str** | Alternate contact information for your business,such as an email address or URL. This value might be displayed on the cardholder's statement. When you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used. Important This value must consist of English characters | [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/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md new file mode 100644 index 00000000..5c6f56de --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**creator** | **str** | The creator of the Payment Instrument. | [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/Tmsv2customersEmbeddedDefaultShippingAddress.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddress.md new file mode 100644 index 00000000..35660580 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultShippingAddress.md @@ -0,0 +1,14 @@ +# Tmsv2customersEmbeddedDefaultShippingAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Tmsv2customersEmbeddedDefaultShippingAddressLinks**](Tmsv2customersEmbeddedDefaultShippingAddressLinks.md) | | [optional] +**id** | **str** | The Id of the Shipping Address Token. | [optional] +**default** | **bool** | Flag that indicates whether customer shipping address is the dafault. Possible Values: - `true`: Shipping Address is customer's default. - `false`: Shipping Address is not customer's default. | [optional] +**ship_to** | [**Tmsv2customersEmbeddedDefaultShippingAddressShipTo**](Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md) | | [optional] +**metadata** | [**Tmsv2customersEmbeddedDefaultShippingAddressMetadata**](Tmsv2customersEmbeddedDefaultShippingAddressMetadata.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/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md new file mode 100644 index 00000000..905976a9 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md @@ -0,0 +1,11 @@ +# Tmsv2customersEmbeddedDefaultShippingAddressLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf**](Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md) | | [optional] +**customer** | [**Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer**](Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.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/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md new file mode 100644 index 00000000..c605d986 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Customer | [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/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md new file mode 100644 index 00000000..9cf612d4 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Customers Shipping 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/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md new file mode 100644 index 00000000..72151cf0 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md @@ -0,0 +1,10 @@ +# Tmsv2customersEmbeddedDefaultShippingAddressMetadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**creator** | **str** | The creator of the Shipping 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/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md b/docs/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md new file mode 100644 index 00000000..639ccf44 --- /dev/null +++ b/docs/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md @@ -0,0 +1,20 @@ +# Tmsv2customersEmbeddedDefaultShippingAddressShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | First name of the recipient. | [optional] +**last_name** | **str** | Last name of the recipient. | [optional] +**company** | **str** | Company associated with the shipping address. | [optional] +**address1** | **str** | First line of the shipping address. | [optional] +**address2** | **str** | Second line of the shipping address. | [optional] +**locality** | **str** | City of the shipping address. | [optional] +**administrative_area** | **str** | State or province of the shipping address. Use 2 character the State, Province, and Territory Codes for the United States and Canada. | [optional] +**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, truncates the value starting from the right side. | [optional] +**country** | **str** | Country of the shipping address. Use the two-character ISO Standard Country Codes. | [optional] +**email** | **str** | Email associated with the shipping address. | [optional] +**phone_number** | **str** | Phone number associated with the shipping 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/Tmsv2customersLinks.md b/docs/Tmsv2customersLinks.md new file mode 100644 index 00000000..00ceccbe --- /dev/null +++ b/docs/Tmsv2customersLinks.md @@ -0,0 +1,12 @@ +# Tmsv2customersLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Tmsv2customersLinksSelf**](Tmsv2customersLinksSelf.md) | | [optional] +**payment_instruments** | [**Tmsv2customersLinksPaymentInstruments**](Tmsv2customersLinksPaymentInstruments.md) | | [optional] +**shipping_address** | [**Tmsv2customersLinksShippingAddress**](Tmsv2customersLinksShippingAddress.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/Tmsv2customersLinksPaymentInstruments.md b/docs/Tmsv2customersLinksPaymentInstruments.md new file mode 100644 index 00000000..880618d7 --- /dev/null +++ b/docs/Tmsv2customersLinksPaymentInstruments.md @@ -0,0 +1,10 @@ +# Tmsv2customersLinksPaymentInstruments + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Customers Payment Instruments. | [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/Tmsv2customersLinksSelf.md b/docs/Tmsv2customersLinksSelf.md new file mode 100644 index 00000000..5cf6c4f3 --- /dev/null +++ b/docs/Tmsv2customersLinksSelf.md @@ -0,0 +1,10 @@ +# Tmsv2customersLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Customer. | [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/Tmsv2customersLinksShippingAddress.md b/docs/Tmsv2customersLinksShippingAddress.md new file mode 100644 index 00000000..2281b09a --- /dev/null +++ b/docs/Tmsv2customersLinksShippingAddress.md @@ -0,0 +1,10 @@ +# Tmsv2customersLinksShippingAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | Link to the Customers Shipping Addresses. | [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/Tmsv2customersMerchantDefinedInformation.md b/docs/Tmsv2customersMerchantDefinedInformation.md new file mode 100644 index 00000000..66e79196 --- /dev/null +++ b/docs/Tmsv2customersMerchantDefinedInformation.md @@ -0,0 +1,11 @@ +# Tmsv2customersMerchantDefinedInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The number you assign as the name for your merchant-defined data or secure field. Possible Values are data1 to data4 and sensitive1 to sensitive4 For example, to set the name for merchant-defined data 2 field, you would reference merchantDefinedInformation[x].name as data2 Possible Values: - data1 - data2 - data3 - data4 - sensitive1 - sensitive2 - sensitive3 - sensitive4 | [optional] +**value** | **str** | 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 it is discovered a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account will immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. | [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/Tmsv2customersMetadata.md b/docs/Tmsv2customersMetadata.md new file mode 100644 index 00000000..6dbd74da --- /dev/null +++ b/docs/Tmsv2customersMetadata.md @@ -0,0 +1,10 @@ +# Tmsv2customersMetadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**creator** | **str** | The creator of the Customer. | [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/Tmsv2customersObjectInformation.md b/docs/Tmsv2customersObjectInformation.md new file mode 100644 index 00000000..ec708b25 --- /dev/null +++ b/docs/Tmsv2customersObjectInformation.md @@ -0,0 +1,11 @@ +# Tmsv2customersObjectInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **str** | Name or title of the customer. | [optional] +**comment** | **str** | Comments that you can make about the customer. | [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/TokenApi.md b/docs/TokenApi.md new file mode 100644 index 00000000..d334c50b --- /dev/null +++ b/docs/TokenApi.md @@ -0,0 +1,114 @@ +# CyberSource.TokenApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_card_art_asset**](TokenApi.md#get_card_art_asset) | **GET** /tms/v2/tokens/{instrumentIdentifierId}/{tokenProvider}/assets/{assetType} | Retrieve Card Art +[**post_token_payment_credentials**](TokenApi.md#post_token_payment_credentials) | **POST** /tms/v2/tokens/{tokenId}/payment-credentials | Generate Payment Credentials for a TMS Token + + +# **get_card_art_asset** +> InlineResponse200 get_card_art_asset(instrument_identifier_id, token_provider, asset_type) + +Retrieve Card Art + +Retrieves Card Art for a specific Instrument Identifier. The Card Art is a visual representation of the cardholder's payment card. Card Art is only available if a Network Token is successfully provisioned. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TokenApi() +instrument_identifier_id = 'instrument_identifier_id_example' # str | The Id of an Instrument Identifier. +token_provider = 'token_provider_example' # str | The token provider. +asset_type = 'asset_type_example' # str | The type of asset. + +try: + # Retrieve Card Art + api_response = api_instance.get_card_art_asset(instrument_identifier_id, token_provider, asset_type) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenApi->get_card_art_asset: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **instrument_identifier_id** | **str**| The Id of an Instrument Identifier. | + **token_provider** | **str**| The token provider. | + **asset_type** | **str**| The type of asset. | + +### Return type + +[**InlineResponse200**](InlineResponse200.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_token_payment_credentials** +> str post_token_payment_credentials(token_id, post_payment_credentials_request, profile_id=profile_id) + +Generate Payment Credentials for a TMS Token + +| | | | | --- | --- | --- | |**Token**
A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|      |**Payment Credentials**
Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.
Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TokenApi() +token_id = 'token_id_example' # str | The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. +post_payment_credentials_request = CyberSource.PostPaymentCredentialsRequest() # PostPaymentCredentialsRequest | +profile_id = 'profile_id_example' # str | The Id of a profile containing user specific TMS configuration. (optional) + +try: + # Generate Payment Credentials for a TMS Token + api_response = api_instance.post_token_payment_credentials(token_id, post_payment_credentials_request, profile_id=profile_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenApi->post_token_payment_credentials: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **token_id** | **str**| The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. | + **post_payment_credentials_request** | [**PostPaymentCredentialsRequest**](PostPaymentCredentialsRequest.md)| | + **profile_id** | **str**| The Id of a profile containing user specific TMS configuration. | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/jose;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TokenPermissions.md b/docs/TokenPermissions.md new file mode 100644 index 00000000..1956c5fd --- /dev/null +++ b/docs/TokenPermissions.md @@ -0,0 +1,13 @@ +# TokenPermissions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**create** | **bool** | Indicates if tokens may be created | [optional] +**read** | **bool** | Indicates if tokens may be read | [optional] +**update** | **bool** | Indicates if tokens may be updated | [optional] +**delete** | **bool** | Indicates if tokens may be deleted | [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/TokenizedCardApi.md b/docs/TokenizedCardApi.md new file mode 100644 index 00000000..42613005 --- /dev/null +++ b/docs/TokenizedCardApi.md @@ -0,0 +1,160 @@ +# CyberSource.TokenizedCardApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_tokenized_card**](TokenizedCardApi.md#delete_tokenized_card) | **DELETE** /tms/v2/tokenized-cards/{tokenizedCardId} | Delete a Tokenized Card +[**get_tokenized_card**](TokenizedCardApi.md#get_tokenized_card) | **GET** /tms/v2/tokenized-cards/{tokenizedCardId} | Retrieve a Tokenized Card +[**post_tokenized_card**](TokenizedCardApi.md#post_tokenized_card) | **POST** /tms/v2/tokenized-cards | Create a Tokenized Card + + +# **delete_tokenized_card** +> delete_tokenized_card(tokenized_card_id, profile_id=profile_id) + +Delete a Tokenized Card + +| | | | | --- | --- | --- | | The Network Token will attempt to be deleted from the card association and if successful the corresponding TMS Network Token will be deleted. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TokenizedCardApi() +tokenized_card_id = 'tokenized_card_id_example' # str | The Id of a tokenized card. +profile_id = 'profile_id_example' # str | The Id of a profile containing user specific TMS configuration. (optional) + +try: + # Delete a Tokenized Card + api_instance.delete_tokenized_card(tokenized_card_id, profile_id=profile_id) +except ApiException as e: + print("Exception when calling TokenizedCardApi->delete_tokenized_card: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tokenized_card_id** | **str**| The Id of a tokenized card. | + **profile_id** | **str**| The Id of a profile containing user specific TMS configuration. | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tokenized_card** +> TokenizedcardRequest get_tokenized_card(tokenized_card_id, profile_id=profile_id) + +Retrieve a Tokenized Card + +| | | | | --- | --- | --- | |**Tokenized Cards**
A Tokenized Card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TokenizedCardApi() +tokenized_card_id = 'tokenized_card_id_example' # str | The Id of a tokenized card. +profile_id = 'profile_id_example' # str | The Id of a profile containing user specific TMS configuration. (optional) + +try: + # Retrieve a Tokenized Card + api_response = api_instance.get_tokenized_card(tokenized_card_id, profile_id=profile_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizedCardApi->get_tokenized_card: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tokenized_card_id** | **str**| The Id of a tokenized card. | + **profile_id** | **str**| The Id of a profile containing user specific TMS configuration. | [optional] + +### Return type + +[**TokenizedcardRequest**](TokenizedcardRequest.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_tokenized_card** +> TokenizedcardRequest post_tokenized_card(tokenizedcard_request, profile_id=profile_id) + +Create a Tokenized Card + +| | | | | --- | --- | --- | |**Tokenized cards**
A Tokenized card represents a network token. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TokenizedCardApi() +tokenizedcard_request = CyberSource.TokenizedcardRequest() # TokenizedcardRequest | +profile_id = 'profile_id_example' # str | The Id of a profile containing user specific TMS configuration. (optional) + +try: + # Create a Tokenized Card + api_response = api_instance.post_tokenized_card(tokenizedcard_request, profile_id=profile_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizedCardApi->post_tokenized_card: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tokenizedcard_request** | [**TokenizedcardRequest**](TokenizedcardRequest.md)| | + **profile_id** | **str**| The Id of a profile containing user specific TMS configuration. | [optional] + +### Return type + +[**TokenizedcardRequest**](TokenizedcardRequest.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TokenizedcardRequest.md b/docs/TokenizedcardRequest.md new file mode 100644 index 00000000..22ae8724 --- /dev/null +++ b/docs/TokenizedcardRequest.md @@ -0,0 +1,32 @@ +# TokenizedcardRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Tmsv2TokenizedCardLinks**](Tmsv2TokenizedCardLinks.md) | | [optional] +**id** | **str** | The Id of the Tokenized Card. | [optional] +**object** | **str** | The type. Possible Values: - tokenizedCard | [optional] +**account_reference_id** | **str** | An identifier provided by the issuer for the account. | [optional] +**consumer_id** | **str** | Identifier of the consumer within the wallet. Maximum 24 characters for VTS. | [optional] +**create_instrument_identifier** | **bool** | Specifies whether the InstrumentId should be created (true) or not (false). Possible Values: - `true`: The InstrumentId should be created. - `false`: The InstrumentId should be created. | [optional] +**source** | **str** | Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER | [optional] +**state** | **str** | State of the network token or network token provision. Possible Values: ACTIVE : Network token is active. SUSPENDED : Network token is suspended. This state can change back to ACTIVE. DELETED : This is a final state for a network token instance. UNPROVISIONED : A previous network token. | [optional] +**reason** | **str** | Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration. | [optional] +**number** | **str** | The token requestor's network token for the provided PAN and consumer Id, if available. | [optional] +**expiration_month** | **str** | Two-digit month in which the network token expires. Format: `MM`. Possible Values: `01` through `12`. | [optional] +**expiration_year** | **str** | Four-digit year in which the network token expires. Format: `YYYY`. | [optional] +**type** | **str** | The type of card (Card Network). Possible Values: - visa - mastercard - americanexpress | [optional] +**cryptogram** | **str** | Value generated by the card association to be used alongside the network token for processing a payment. | [optional] +**security_code** | **str** | 4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF. | [optional] +**eci** | **str** | Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication. | [optional] +**requestor_id** | **str** | 11-digit identifier that uniquely identifies the Token Requestor. | [optional] +**enrollment_id** | **str** | Unique id to identify this PAN/ enrollment. | [optional] +**token_reference_id** | **str** | Unique ID for netwrok token. | [optional] +**payment_account_reference** | **str** | Payment account reference. | [optional] +**card** | [**Tmsv2TokenizedCardCard**](Tmsv2TokenizedCardCard.md) | | [optional] +**passcode** | [**Tmsv2TokenizedCardPasscode**](Tmsv2TokenizedCardPasscode.md) | | [optional] +**metadata** | [**Tmsv2TokenizedCardMetadata**](Tmsv2TokenizedCardMetadata.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/TransactionBatchesApi.md b/docs/TransactionBatchesApi.md new file mode 100644 index 00000000..379a800b --- /dev/null +++ b/docs/TransactionBatchesApi.md @@ -0,0 +1,208 @@ +# CyberSource.TransactionBatchesApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_transaction_batch_details**](TransactionBatchesApi.md#get_transaction_batch_details) | **GET** /pts/v1/transaction-batch-details/{id} | Get Transaction Details for a given Batch Id +[**get_transaction_batch_id**](TransactionBatchesApi.md#get_transaction_batch_id) | **GET** /pts/v1/transaction-batches/{id} | Get Individual Batch File +[**get_transaction_batches**](TransactionBatchesApi.md#get_transaction_batches) | **GET** /pts/v1/transaction-batches | Get a List of Batch Files +[**upload_transaction_batch**](TransactionBatchesApi.md#upload_transaction_batch) | **POST** /pts/v1/transaction-batch-upload | Upload a Batch File + + +# **get_transaction_batch_details** +> get_transaction_batch_details(id, upload_date=upload_date, status=status) + +Get Transaction Details for a given Batch Id + +Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TransactionBatchesApi() +id = 'id_example' # str | The batch id assigned for the template. +upload_date = '2013-10-20' # date | Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd (optional) +status = 'status_example' # str | Allows you to filter by rejected response. Valid values: - Rejected (optional) + +try: + # Get Transaction Details for a given Batch Id + api_instance.get_transaction_batch_details(id, upload_date=upload_date, status=status) +except ApiException as e: + print("Exception when calling TransactionBatchesApi->get_transaction_batch_details: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The batch id assigned for the template. | + **upload_date** | **date**| Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd | [optional] + **status** | **str**| Allows you to filter by rejected response. Valid values: - Rejected | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: text/csv, application/xml, text/vnd.cybersource.map-csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transaction_batch_id** +> PtsV1TransactionBatchesIdGet200Response get_transaction_batch_id(id) + +Get Individual Batch File + +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 +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TransactionBatchesApi() +id = 'id_example' # str | The batch id assigned for the template. + +try: + # Get Individual Batch File + api_response = api_instance.get_transaction_batch_id(id) + pprint(api_response) +except ApiException as e: + print("Exception when calling TransactionBatchesApi->get_transaction_batch_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The batch id assigned for the template. | + +### Return type + +[**PtsV1TransactionBatchesIdGet200Response**](PtsV1TransactionBatchesIdGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transaction_batches** +> PtsV1TransactionBatchesGet200Response get_transaction_batches(start_time, end_time) + +Get a List of Batch Files + +Provide the date and time search range to get a list of Batch Files ready for settlement + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TransactionBatchesApi() +start_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ +end_time = '2013-10-20T19:20:30+01:00' # datetime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ + +try: + # Get a List of Batch Files + api_response = api_instance.get_transaction_batches(start_time, end_time) + pprint(api_response) +except ApiException as e: + print("Exception when calling TransactionBatchesApi->get_transaction_batches: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **start_time** | **datetime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | + **end_time** | **datetime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZZ | + +### Return type + +[**PtsV1TransactionBatchesGet200Response**](PtsV1TransactionBatchesGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upload_transaction_batch** +> upload_transaction_batch(file) + +Upload a Batch File + +This endpoint enables the upload of a batch file containing transactions for processing. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TransactionBatchesApi() +file = '/path/to/file.txt' # file | The file to upload. + +try: + # Upload a Batch File + api_instance.upload_transaction_batch(file) +except ApiException as e: + print("Exception when calling TransactionBatchesApi->upload_transaction_batch: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | **file**| The file to upload. | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TransactionDetailsApi.md b/docs/TransactionDetailsApi.md new file mode 100644 index 00000000..a6705efa --- /dev/null +++ b/docs/TransactionDetailsApi.md @@ -0,0 +1,57 @@ +# CyberSource.TransactionDetailsApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_transaction**](TransactionDetailsApi.md#get_transaction) | **GET** /tss/v2/transactions/{id} | Retrieve a Transaction + + +# **get_transaction** +> TssV2TransactionsGet200Response get_transaction(id) + +Retrieve a Transaction + +Include the Request ID in the GET request to retrieve the transaction details. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TransactionDetailsApi() +id = 'id_example' # str | Request ID. + +try: + # Retrieve a Transaction + api_response = api_instance.get_transaction(id) + pprint(api_response) +except ApiException as e: + print("Exception when calling TransactionDetailsApi->get_transaction: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Request ID. | + +### Return type + +[**TssV2TransactionsGet200Response**](TssV2TransactionsGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TransientTokenDataApi.md b/docs/TransientTokenDataApi.md new file mode 100644 index 00000000..547b305d --- /dev/null +++ b/docs/TransientTokenDataApi.md @@ -0,0 +1,105 @@ +# CyberSource.TransientTokenDataApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_payment_credentials_for_transient_token**](TransientTokenDataApi.md#get_payment_credentials_for_transient_token) | **GET** /flex/v2/payment-credentials/{paymentCredentialsReference} | Get Payment Credentials +[**get_transaction_for_transient_token**](TransientTokenDataApi.md#get_transaction_for_transient_token) | **GET** /up/v1/payment-details/{transientToken} | Get Transient Token Data + + +# **get_payment_credentials_for_transient_token** +> str get_payment_credentials_for_transient_token(payment_credentials_reference) + +Get Payment Credentials + +Retrieve the Payment data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will return PCI payment data captured by the Unified Checkout platform. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TransientTokenDataApi() +payment_credentials_reference = 'payment_credentials_reference_example' # str | The paymentCredentialsReference field contained within the Transient token returned from a successful Unified Checkout transaction + +try: + # Get Payment Credentials + api_response = api_instance.get_payment_credentials_for_transient_token(payment_credentials_reference) + pprint(api_response) +except ApiException as e: + print("Exception when calling TransientTokenDataApi->get_payment_credentials_for_transient_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **payment_credentials_reference** | **str**| The paymentCredentialsReference field contained within the Transient token returned from a successful Unified Checkout transaction | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/jwt + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transaction_for_transient_token** +> get_transaction_for_transient_token(transient_token) + +Get Transient Token Data + +Retrieve the data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will not return PCI payment data (PAN). Include the Request ID in the GET request to retrieve the transaction details. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.TransientTokenDataApi() +transient_token = 'transient_token_example' # str | Transient Token returned by the Unified Checkout application. + +try: + # Get Transient Token Data + api_instance.get_transaction_for_transient_token(transient_token) +except ApiException as e: + print("Exception when calling TransientTokenDataApi->get_transaction_for_transient_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transient_token** | **str**| Transient Token returned by the Unified Checkout application. | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TssV2GetEmvTags200Response.md b/docs/TssV2GetEmvTags200Response.md new file mode 100644 index 00000000..40712805 --- /dev/null +++ b/docs/TssV2GetEmvTags200Response.md @@ -0,0 +1,10 @@ +# TssV2GetEmvTags200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**emv_tag_breakdown_list** | [**list[TssV2GetEmvTags200ResponseEmvTagBreakdownList]**](TssV2GetEmvTags200ResponseEmvTagBreakdownList.md) | An array of objects with each object containing a single EMV tag from the dictionary. | [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/TssV2GetEmvTags200ResponseEmvTagBreakdownList.md b/docs/TssV2GetEmvTags200ResponseEmvTagBreakdownList.md new file mode 100644 index 00000000..64543124 --- /dev/null +++ b/docs/TssV2GetEmvTags200ResponseEmvTagBreakdownList.md @@ -0,0 +1,11 @@ +# TssV2GetEmvTags200ResponseEmvTagBreakdownList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tag** | **str** | Hexadecimal code of tag. | [optional] +**name** | **str** | Name of tag. | [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/TssV2PostEmvTags200Response.md b/docs/TssV2PostEmvTags200Response.md new file mode 100644 index 00000000..20ac9347 --- /dev/null +++ b/docs/TssV2PostEmvTags200Response.md @@ -0,0 +1,10 @@ +# TssV2PostEmvTags200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parsed_emv_tags_list** | [**list[TssV2PostEmvTags200ResponseParsedEMVTagsList]**](TssV2PostEmvTags200ResponseParsedEMVTagsList.md) | An array of objects (one per object in the passed emvDetailsList), each of which contains a fully parsed EMV string | [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/TssV2PostEmvTags200ResponseEmvTagBreakdownList.md b/docs/TssV2PostEmvTags200ResponseEmvTagBreakdownList.md new file mode 100644 index 00000000..d31ef973 --- /dev/null +++ b/docs/TssV2PostEmvTags200ResponseEmvTagBreakdownList.md @@ -0,0 +1,14 @@ +# TssV2PostEmvTags200ResponseEmvTagBreakdownList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tag** | **str** | Hexadecimal code of tag. | [optional] +**name** | **str** | Name of tag. | [optional] +**length** | **int** | Tag length in bytes. | [optional] +**value** | **str** | Hexadecimal value contained in the tag, masked data is represented by an 'X'. | [optional] +**description** | **str** | Description of tag. | [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/TssV2PostEmvTags200ResponseParsedEMVTagsList.md b/docs/TssV2PostEmvTags200ResponseParsedEMVTagsList.md new file mode 100644 index 00000000..86b203dc --- /dev/null +++ b/docs/TssV2PostEmvTags200ResponseParsedEMVTagsList.md @@ -0,0 +1,12 @@ +# TssV2PostEmvTags200ResponseParsedEMVTagsList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**total_tags** | **int** | Number of tags parsed | [optional] +**emv_tag_breakdown_list** | [**list[TssV2PostEmvTags200ResponseEmvTagBreakdownList]**](TssV2PostEmvTags200ResponseEmvTagBreakdownList.md) | An array of objects, where each object contains one parsed tag from the relevant EMV string. | [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/TssV2TransactionsGet200Response.md b/docs/TssV2TransactionsGet200Response.md new file mode 100644 index 00000000..c8108a01 --- /dev/null +++ b/docs/TssV2TransactionsGet200Response.md @@ -0,0 +1,40 @@ +# TssV2TransactionsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**root_id** | **str** | Contains the transaction identifier for the first transaction in the series of transactions. For example, you might send an authorization request for a payment, followed by a capture request for that payment, and then a refund request for that captured payment. Each of those requests, if successful, creates a resource that is assigned an identifier, which is returned in the response. The rootId identifies the first ID in the series, which in this case would be the ID of the original authorization. | [optional] +**reconciliation_id** | **str** | 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] +**merchant_id** | **str** | Your CyberSource merchant ID. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. | [optional] +**application_information** | [**TssV2TransactionsGet200ResponseApplicationInformation**](TssV2TransactionsGet200ResponseApplicationInformation.md) | | [optional] +**bank_account_validation** | [**TssV2TransactionsGet200ResponseBankAccountValidation**](TssV2TransactionsGet200ResponseBankAccountValidation.md) | | [optional] +**buyer_information** | [**TssV2TransactionsGet200ResponseBuyerInformation**](TssV2TransactionsGet200ResponseBuyerInformation.md) | | [optional] +**client_reference_information** | [**TssV2TransactionsGet200ResponseClientReferenceInformation**](TssV2TransactionsGet200ResponseClientReferenceInformation.md) | | [optional] +**consumer_authentication_information** | [**TssV2TransactionsGet200ResponseConsumerAuthenticationInformation**](TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md) | | [optional] +**device_information** | [**TssV2TransactionsGet200ResponseDeviceInformation**](TssV2TransactionsGet200ResponseDeviceInformation.md) | | [optional] +**error_information** | [**TssV2TransactionsGet200ResponseErrorInformation**](TssV2TransactionsGet200ResponseErrorInformation.md) | | [optional] +**installment_information** | [**TssV2TransactionsGet200ResponseInstallmentInformation**](TssV2TransactionsGet200ResponseInstallmentInformation.md) | | [optional] +**fraud_marking_information** | [**TssV2TransactionsGet200ResponseFraudMarkingInformation**](TssV2TransactionsGet200ResponseFraudMarkingInformation.md) | | [optional] +**health_care_information** | [**Ptsv2paymentsHealthCareInformation**](Ptsv2paymentsHealthCareInformation.md) | | [optional] +**merchant_defined_information** | [**list[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] +**merchant_information** | [**TssV2TransactionsGet200ResponseMerchantInformation**](TssV2TransactionsGet200ResponseMerchantInformation.md) | | [optional] +**order_information** | [**TssV2TransactionsGet200ResponseOrderInformation**](TssV2TransactionsGet200ResponseOrderInformation.md) | | [optional] +**payment_information** | [**TssV2TransactionsGet200ResponsePaymentInformation**](TssV2TransactionsGet200ResponsePaymentInformation.md) | | [optional] +**payment_insights_information** | [**PtsV2PaymentsPost201ResponsePaymentInsightsInformation**](PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md) | | [optional] +**payout_options** | [**TssV2TransactionsGet200ResponsePayoutOptions**](TssV2TransactionsGet200ResponsePayoutOptions.md) | | [optional] +**unscheduled_payment_information** | [**Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) | | [optional] +**processing_information** | [**TssV2TransactionsGet200ResponseProcessingInformation**](TssV2TransactionsGet200ResponseProcessingInformation.md) | | [optional] +**processor_information** | [**TssV2TransactionsGet200ResponseProcessorInformation**](TssV2TransactionsGet200ResponseProcessorInformation.md) | | [optional] +**recurring_payment_information** | [**TssV2TransactionsGet200ResponseRecurringPaymentInformation**](TssV2TransactionsGet200ResponseRecurringPaymentInformation.md) | | [optional] +**point_of_sale_information** | [**TssV2TransactionsGet200ResponsePointOfSaleInformation**](TssV2TransactionsGet200ResponsePointOfSaleInformation.md) | | [optional] +**risk_information** | [**TssV2TransactionsGet200ResponseRiskInformation**](TssV2TransactionsGet200ResponseRiskInformation.md) | | [optional] +**sender_information** | [**TssV2TransactionsGet200ResponseSenderInformation**](TssV2TransactionsGet200ResponseSenderInformation.md) | | [optional] +**token_information** | [**TssV2TransactionsGet200ResponseTokenInformation**](TssV2TransactionsGet200ResponseTokenInformation.md) | | [optional] +**links** | [**TssV2TransactionsGet200ResponseLinks**](TssV2TransactionsGet200ResponseLinks.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/TssV2TransactionsGet200ResponseApplicationInformation.md b/docs/TssV2TransactionsGet200ResponseApplicationInformation.md new file mode 100644 index 00000000..8c221623 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseApplicationInformation.md @@ -0,0 +1,14 @@ +# TssV2TransactionsGet200ResponseApplicationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | The status of the submitted transaction. | [optional] +**reason_code** | **str** | Indicates the reason why a request succeeded or failed and possible action to take if a request fails. For details, see the appendix of reason codes in the documentation for the relevant payment method. | [optional] +**r_code** | **str** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional] +**r_flag** | **str** | One-word description of the result of the application. | [optional] +**applications** | [**list[TssV2TransactionsGet200ResponseApplicationInformationApplications]**](TssV2TransactionsGet200ResponseApplicationInformationApplications.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/TssV2TransactionsGet200ResponseApplicationInformationApplications.md b/docs/TssV2TransactionsGet200ResponseApplicationInformationApplications.md new file mode 100644 index 00000000..c3466659 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseApplicationInformationApplications.md @@ -0,0 +1,17 @@ +# TssV2TransactionsGet200ResponseApplicationInformationApplications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the CyberSource transaction type (such as CC settlement or CC authorization) that the merchant wants to process in a transaction request. More than one transaction type can included in a transaction request. Each transaction type separately returns their own status, reasonCode, rCode, and rFlag messages. | [optional] +**status** | **str** | The description for this field is not available. | [optional] +**reason_code** | **str** | 3-digit reason code that indicates why the customer profile payment succeeded or failed. | [optional] +**r_code** | **str** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional] +**r_flag** | **str** | One-word description of the result of the application. | [optional] +**reconciliation_id** | **str** | Reference number that you use to reconcile your CyberSource reports with your processor reports. | [optional] +**r_message** | **str** | Message that explains the reply flag for the application. | [optional] +**return_code** | **int** | The description for this field is not available. | [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/TssV2TransactionsGet200ResponseBankAccountValidation.md b/docs/TssV2TransactionsGet200ResponseBankAccountValidation.md new file mode 100644 index 00000000..a33ff737 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseBankAccountValidation.md @@ -0,0 +1,12 @@ +# TssV2TransactionsGet200ResponseBankAccountValidation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**raw_validation_code** | **int** | Raw Validation Codes for routing number and account number Possible values: • -1: Unable to perform validation/Unknown error • -2: Service Unavailable • 12 to 16: Validation results | [optional] +**result_code** | **int** | Result codes for account number and routing number Possible values: 00, 04, 98, 99 | [optional] +**result_message** | **str** | | [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/TssV2TransactionsGet200ResponseBuyerInformation.md b/docs/TssV2TransactionsGet200ResponseBuyerInformation.md new file mode 100644 index 00000000..76a3c624 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseBuyerInformation.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_customer_id** | **str** | 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] +**hashed_password** | **str** | 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/TssV2TransactionsGet200ResponseClientReferenceInformation.md b/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md new file mode 100644 index 00000000..0e23d523 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md @@ -0,0 +1,15 @@ +# TssV2TransactionsGet200ResponseClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | 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] +**application_version** | **str** | Version of the CyberSource application or integration used for a transaction. | [optional] +**application_name** | **str** | 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] +**application_user** | **str** | 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. | [optional] +**partner** | [**TssV2TransactionsGet200ResponseClientReferenceInformationPartner**](TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md) | | [optional] +**comments** | **str** | 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/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md b/docs/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md new file mode 100644 index 00000000..c55f9d71 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseClientReferenceInformationPartner + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**solution_id** | **str** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [optional] +**third_party_certification_number** | **str** | Value that identifies the application vendor and application version for a third party gateway. CyberSource provides you with this value during testing and validation. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization, Authorization Reversal, Capture, Credit, Incremental Authorization, and Void** Optional field. #### PIN debit Required field for PIN debit credit, PIN debit purchase, or PIN debit reversal request. | [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/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md new file mode 100644 index 00000000..eb684e6a --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md @@ -0,0 +1,14 @@ +# TssV2TransactionsGet200ResponseConsumerAuthenticationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eci_raw** | **str** | Raw electronic commerce indicator (ECI). | [optional] +**cavv** | **str** | Cardholder authentication verification value (CAVV). | [optional] +**xid** | **str** | Transaction identifier. | [optional] +**transaction_id** | **str** | Payer auth Transaction identifier. | [optional] +**strong_authentication** | [**TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication**](TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.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/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md new file mode 100644 index 00000000..be33567e --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication.md @@ -0,0 +1,14 @@ +# TssV2TransactionsGet200ResponseConsumerAuthenticationInformationStrongAuthentication + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**low_value_exemption_indicator** | **str** | This field will contain the low value exemption indicator with one of the following values: Possible values: - `0` ( low value exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it to be a low value payment) | [optional] +**risk_analysis_exemption_indicator** | **str** | This field will contain the transaction risk analysis exemption indicator with one of the following values: Possible values: - `0` (TRA exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it to be low risk in accordance with the criteria defined by PSD2/RTS) | [optional] +**trusted_merchant_exemption_indicator** | **str** | Possible values: - `0` (Trusted merchant exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as it originated at a merchant trusted by the cardholder) | [optional] +**secure_corporate_payment_indicator** | **str** | This field will contain the secure corporate payment exemption indicator with one of the following values: Possible values: - `0` (SCA exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it as a secure corporate payment) | [optional] +**delegated_authentication_exemption_indicator** | **str** | This field will contain the delegated authentication exemption indicator with one of the following values: Possible values: - `0` (delegated Authentication exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as authentication has been delegated to other provider (PSP,Acquirer)) | [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/TssV2TransactionsGet200ResponseDeviceInformation.md b/docs/TssV2TransactionsGet200ResponseDeviceInformation.md new file mode 100644 index 00000000..dc4c6da0 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseDeviceInformation.md @@ -0,0 +1,12 @@ +# TssV2TransactionsGet200ResponseDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ip_address** | **str** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional] +**host_name** | **str** | DNS resolved hostname from `ipAddress`. | [optional] +**cookies_accepted** | **str** | Whether the customer's browser accepts cookies. This field can contain one of the following values: - `yes`: The customer's browser accepts cookies. - `no`: The customer's browser does not accept cookies. | [optional] + +[[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/TssV2TransactionsGet200ResponseErrorInformation.md b/docs/TssV2TransactionsGet200ResponseErrorInformation.md new file mode 100644 index 00000000..c1eca3a0 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseErrorInformation.md @@ -0,0 +1,12 @@ +# TssV2TransactionsGet200ResponseErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | 1-word description of why a request succeeded or failed. | [optional] +**message** | **str** | The user-facing description for why a request succeeded or failed. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/TssV2TransactionsGet200ResponseFraudMarkingInformation.md b/docs/TssV2TransactionsGet200ResponseFraudMarkingInformation.md new file mode 100644 index 00000000..452b4333 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseFraudMarkingInformation.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponseFraudMarkingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | Reason for adding the transaction to the negative list. This field can contain one of the following values: - fraud_chargeback: You have received a fraudrelated chargeback for the transaction. - non_fraud_chargeback: You have received a non-fraudulent chargeback for the transaction. - suspected: You believe that you will probably receive a chargeback for the transaction. - creditback: You issued a refund to the customer to avoid a chargeback for the 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/TssV2TransactionsGet200ResponseInstallmentInformation.md b/docs/TssV2TransactionsGet200ResponseInstallmentInformation.md new file mode 100644 index 00000000..65753d0b --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseInstallmentInformation.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseInstallmentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number_of_installments** | **str** | Number of Installments. | [optional] +**identifier** | **str** | Standing Instruction/Installment identifier. | [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/TssV2TransactionsGet200ResponseLinks.md b/docs/TssV2TransactionsGet200ResponseLinks.md new file mode 100644 index 00000000..cdb51294 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseLinks.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.md) | | [optional] +**related_transactions** | [**list[PtsV2PaymentsPost201ResponseLinksSelf]**](PtsV2PaymentsPost201ResponseLinksSelf.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/TssV2TransactionsGet200ResponseMerchantInformation.md b/docs/TssV2TransactionsGet200ResponseMerchantInformation.md new file mode 100644 index 00000000..6dbe047b --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseMerchantInformation.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponseMerchantInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_descriptor** | [**TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor**](TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.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/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.md b/docs/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.md new file mode 100644 index 00000000..58dc4285 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. **Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. **Important** This value must consist of English characters. Required for captures and credits. | [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/TssV2TransactionsGet200ResponseOrderInformation.md b/docs/TssV2TransactionsGet200ResponseOrderInformation.md new file mode 100644 index 00000000..84ddea2d --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseOrderInformation.md @@ -0,0 +1,15 @@ +# TssV2TransactionsGet200ResponseOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bill_to** | [**TssV2TransactionsGet200ResponseOrderInformationBillTo**](TssV2TransactionsGet200ResponseOrderInformationBillTo.md) | | [optional] +**ship_to** | [**TssV2TransactionsGet200ResponseOrderInformationShipTo**](TssV2TransactionsGet200ResponseOrderInformationShipTo.md) | | [optional] +**line_items** | [**list[TssV2TransactionsGet200ResponseOrderInformationLineItems]**](TssV2TransactionsGet200ResponseOrderInformationLineItems.md) | Transaction Line Item data. | [optional] +**amount_details** | [**TssV2TransactionsGet200ResponseOrderInformationAmountDetails**](TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md) | | [optional] +**shipping_details** | [**TssV2TransactionsGet200ResponseOrderInformationShippingDetails**](TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md) | | [optional] +**invoice_details** | [**TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails**](TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.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/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md new file mode 100644 index 00000000..87134df8 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md @@ -0,0 +1,16 @@ +# TssV2TransactionsGet200ResponseOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_amount** | **str** | 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 / Pay By Link Required for creating a new invoice or payment link. #### 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** | **str** | 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] +**tax_amount** | **str** | Total tax amount for all the items in the order. | [optional] +**authorized_amount** | **str** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. | [optional] +**settlement_amount** | **str** | 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] +**settlement_currency** | **str** | 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** | [**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/TssV2TransactionsGet200ResponseOrderInformationBillTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md new file mode 100644 index 00000000..b7f1f310 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md @@ -0,0 +1,23 @@ +# TssV2TransactionsGet200ResponseOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | 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] +**last_name** | **str** | 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] +**middle_name** | **str** | Customer's middle name. | [optional] +**name_suffix** | **str** | Customer's name suffix. | [optional] +**address1** | **str** | 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] +**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional] +**locality** | **str** | 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] +**administrative_area** | **str** | 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] +**postal_code** | **str** | 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** | **str** | 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** | **str** | 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** | **str** | 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** | **str** | Title. | [optional] +**phone_number** | **str** | 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/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.md new file mode 100644 index 00000000..3f1d428b --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponseOrderInformationInvoiceDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sales_slip_number** | **int** | Transaction identifier that is generated. You have the option of printing the sales slip number on the receipt. This field is supported only on Cybersource through Visanet and JCN gateway. Optional field. #### Card Present processing message If you included this field in the request, the returned value is the value that you sent in the request. If you did not include this field in the request, the system generated this value for you. The difference between this reply field and the `processorInformation.systemTraceAuditNumber` field is that the system generates the system trace audit number (STAN), and you must print the receipt number on the receipt; whereas you can generate the sales slip number, and you can choose to print the sales slip number on the receipt. | [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/TssV2TransactionsGet200ResponseOrderInformationLineItems.md b/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md new file mode 100644 index 00000000..e7fa1f8c --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md @@ -0,0 +1,16 @@ +# TssV2TransactionsGet200ResponseOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**product_code** | **str** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] +**product_name** | **str** | For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] +**product_sku** | **str** | Identification code for the product. For Payment and Capture APIs, this field is required when above `productCode` is not **default** or one of the values related to shipping and/or handling. | [optional] +**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. | [optional] +**quantity** | **int** | For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] +**unit_price** | **str** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. | [optional] +**fulfillment_type** | **str** | The description for this field is not available. | [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/TssV2TransactionsGet200ResponseOrderInformationShipTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md new file mode 100644 index 00000000..1471585b --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md @@ -0,0 +1,19 @@ +# TssV2TransactionsGet200ResponseOrderInformationShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] +**last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] +**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**administrative_area** | **str** | 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] +**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**company** | **str** | Name of the customer's company. | [optional] +**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**phone_number** | **str** | Phone number associated with the shipping 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/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md new file mode 100644 index 00000000..ddc5d2a1 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseOrderInformationShippingDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gift_wrap** | **bool** | Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping. | [optional] +**shipping_method** | **str** | Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription | [optional] + +[[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/TssV2TransactionsGet200ResponsePaymentInformation.md b/docs/TssV2TransactionsGet200ResponsePaymentInformation.md new file mode 100644 index 00000000..8a2214e9 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformation.md @@ -0,0 +1,23 @@ +# TssV2TransactionsGet200ResponsePaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_type** | [**TssV2TransactionsGet200ResponsePaymentInformationPaymentType**](TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md) | | [optional] +**customer** | [**TssV2TransactionsGet200ResponsePaymentInformationCustomer**](TssV2TransactionsGet200ResponsePaymentInformationCustomer.md) | | [optional] +**card** | [**TssV2TransactionsGet200ResponsePaymentInformationCard**](TssV2TransactionsGet200ResponsePaymentInformationCard.md) | | [optional] +**brands** | [**list[TssV2TransactionsGet200ResponsePaymentInformationBrands]**](TssV2TransactionsGet200ResponsePaymentInformationBrands.md) | This array contains the supported brands. | [optional] +**features** | [**TssV2TransactionsGet200ResponsePaymentInformationFeatures**](TssV2TransactionsGet200ResponsePaymentInformationFeatures.md) | | [optional] +**invoice** | [**TssV2TransactionsGet200ResponsePaymentInformationInvoice**](TssV2TransactionsGet200ResponsePaymentInformationInvoice.md) | | [optional] +**network** | [**TssV2TransactionsGet200ResponsePaymentInformationNetwork**](TssV2TransactionsGet200ResponsePaymentInformationNetwork.md) | | [optional] +**issuer_information** | [**TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation**](TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md) | | [optional] +**bank** | [**TssV2TransactionsGet200ResponsePaymentInformationBank**](TssV2TransactionsGet200ResponsePaymentInformationBank.md) | | [optional] +**account_features** | [**TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures**](TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md) | | [optional] +**payment_instrument** | [**PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument**](PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument.md) | | [optional] +**instrument_identifier** | [**TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier**](TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md) | | [optional] +**shipping_address** | [**PtsV2PaymentsPost201ResponseTokenInformationShippingAddress**](PtsV2PaymentsPost201ResponseTokenInformationShippingAddress.md) | | [optional] +**fluid_data** | [**TssV2TransactionsGet200ResponsePaymentInformationFluidData**](TssV2TransactionsGet200ResponsePaymentInformationFluidData.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/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md new file mode 100644 index 00000000..d09f223e --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md @@ -0,0 +1,12 @@ +# TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**balance_amount** | **str** | Remaining balance on the account. Returned by authorization service. #### PIN debit Remaining balance on the prepaid card. Returned by PIN debit purchase. | [optional] +**previous_balance_amount** | **str** | Remaining balance on the account. Returned by authorization service. #### PIN debit Remaining balance on the prepaid card. Returned by PIN debit purchase. | [optional] +**currency** | **str** | Currency of the remaining balance on the account. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) Returned by authorization service. #### PIN debit Currency of the remaining balance on the prepaid card. Returned by PIN debit purchase. | [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/TssV2TransactionsGet200ResponsePaymentInformationBank.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md new file mode 100644 index 00000000..3815d59e --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationBank.md @@ -0,0 +1,16 @@ +# TssV2TransactionsGet200ResponsePaymentInformationBank + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**routing_number** | **str** | Bank routing number. This is also called the transit number. | [optional] +**branch_code** | **str** | 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] +**swift_code** | **str** | Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. | [optional] +**bank_code** | **str** | 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** | **str** | 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** | [**TssV2TransactionsGet200ResponsePaymentInformationBankAccount**](TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md) | | [optional] +**mandate** | [**TssV2TransactionsGet200ResponsePaymentInformationBankMandate**](TssV2TransactionsGet200ResponsePaymentInformationBankMandate.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/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md new file mode 100644 index 00000000..c93a442f --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md @@ -0,0 +1,16 @@ +# TssV2TransactionsGet200ResponsePaymentInformationBankAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**suffix** | **str** | Last four digits of the customer's payment account number. | [optional] +**prefix** | **str** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. | [optional] +**check_number** | **str** | 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** | **str** | 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** | **str** | Name used on the bank account. You can use this field only when scoring a direct debit transaction | [optional] +**check_digit** | **str** | 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] +**encoder_id** | **str** | 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/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md new file mode 100644 index 00000000..4e1f39e2 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.md @@ -0,0 +1,12 @@ +# TssV2TransactionsGet200ResponsePaymentInformationBankMandate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reference_number** | **str** | Unique value generated by CyberSource that identifies the transaction. Use this value to identify transactions in the Collections Report, which provides settlement information. For details, see the `direct_debit_reconciliation_reference_number` reply field description in [Ingenico ePayments Developer Guide For Direct Debits.](https://apps.cybersource.com/library/documentation/dev_guides/Ingenico_ePayments_Dev/html/) | [optional] +**recurring_type** | **str** | Whether the direct debit is the first or last direct debit associated with the mandate, or one in between. Required only for the United Kingdom. Possible values: - `001`: First direct debit associated with this mandate. Use this value if a one-time direct debit). - `002`: Subsequent direct debits associated with this mandate. - `003`: Last direct debit associated with this mandate. For details, see the `direct_debit_recurring_type` request field description in [Ingenico ePayments Developer Guide For Direct Debits.](https://apps.cybersource.com/library/documentation/dev_guides/Ingenico_ePayments_Dev/html/) | [optional] +**id** | **str** | The mandate ID. Required only for the United Kingdom. For details, see the `mandate_id` request field description in [Ingenico ePayments Developer Guide For Direct Debits.](https://apps.cybersource.com/library/documentation/dev_guides/Ingenico_ePayments_Dev/html/) | [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/TssV2TransactionsGet200ResponsePaymentInformationBrands.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBrands.md new file mode 100644 index 00000000..ab722c60 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationBrands.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponsePaymentInformationBrands + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [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/TssV2TransactionsGet200ResponsePaymentInformationCard.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md new file mode 100644 index 00000000..8e39b879 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md @@ -0,0 +1,21 @@ +# TssV2TransactionsGet200ResponsePaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**suffix** | **str** | Last four digits of the cardholder's account number. This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### PIN debit This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. Returned by PIN debit credit and PIN debit purchase. This field is supported only by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional] +**prefix** | **str** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] +**expiration_month** | **str** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] +**expiration_year** | **str** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] +**start_month** | **str** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] +**start_year** | **str** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] +**issue_number** | **str** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. | [optional] +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [optional] +**currency** | **str** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional] +**account_encoder_id** | **str** | Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID. | [optional] +**use_as** | **str** | Flag that specifies the type of account associated with the card. This field is available only for China UnionPay, Cielo, Comercio Latino and Visa Platform Connect. The cardholder provides this information during the payment process. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **China UnionPayCard Transactions on China UnionPay:** Possible values: - C: Domestic credit card - D: Domestic debit card - F: International credit card - I: International debit card When the value is D, the e-commerce indicator and CAVV fields must be included in the authorization request. When the value is C, F or I the card verification number, expiration month and expiration year fields must in included in the authorization request. **Cielo and Comercio Latino Credit Card Transactions:** On these processors, this field is supported only for authorizations. Possible values: - CR: Credit card - DB: Debit card **Visa Platform Connect Credit Card Transactions:** This field is supported for all card types on Visa Platform Connect. For combo **card present** transactions with Mastercard on Brazilian-issued cards, possible values: - CR: Credit card - DB: Debit Card For combo **card not present** transactions with Mastercard on Brazilian-issued cards, possible values: - C: Credit card - D: Debit card A value of CR or DB in the useAs field takes precedence over any value in the Source Account Type 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/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md new file mode 100644 index 00000000..cd7a0c95 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponsePaymentInformationCustomer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer_id** | **str** | 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** | **str** | 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/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md new file mode 100644 index 00000000..5f636bdc --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md @@ -0,0 +1,16 @@ +# TssV2TransactionsGet200ResponsePaymentInformationFeatures + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_funding_source** | **str** | This field contains the account funding source. Possible values: - `CREDIT` - `DEBIT` - `PREPAID` - `DEFERRED DEBIT` - `CHARGE` | [optional] +**account_funding_source_sub_type** | **str** | This field contains the type of prepaid card. Possible values: - `Reloadable` - `Non-reloadable` | [optional] +**card_product** | **str** | This field contains the type of issuer product. Example values: - Visa Classic - Visa Signature - Visa Infinite | [optional] +**message_type** | **str** | This field contains the type of BIN based authentication. Possible values: - `S`: Single Message - `D`: Dual Message | [optional] +**acceptance_level** | **str** | This field contains the acceptance level of the PAN. Possible values: - `0` : Normal - `1` : Monitor - `2` : Refuse - `3` : Not Allowed - `4` : Private - `5` : Test | [optional] +**card_platform** | **str** | This field contains the type of card platform. Possible values: - `BUSINESS` - `CONSUMER` - `COMMERCIAL` - `GOVERNMENT` | [optional] +**combo_card** | **str** | This field indicates the type of combo card. Possible values: - 0 (Not a combo card) - 1 (Credit and Prepaid Combo card) - 2 (Credit and Debit Combo card) | [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/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md new file mode 100644 index 00000000..9a4f86de --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponsePaymentInformationFluidData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**descriptor** | **str** | The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is `Ymx1ZWZpbg==`. paymentInformation.fluidData.encoding must be `Base64`. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is `Base64`, the value is: `RklEPUVNVi5QQVlNRU5ULkFQSQ==` If paymentInformation.fluidData.encoding is `HEX`, the value is: `4649443D454D562E5041594D454E542E41504` | [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/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md new file mode 100644 index 00000000..7e572116 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the Instrument Identifier 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/TssV2TransactionsGet200ResponsePaymentInformationInvoice.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationInvoice.md new file mode 100644 index 00000000..1584793b --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationInvoice.md @@ -0,0 +1,12 @@ +# TssV2TransactionsGet200ResponsePaymentInformationInvoice + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **str** | Invoice Number. | [optional] +**barcode_number** | **str** | Barcode Number. | [optional] +**expiration_date** | **str** | Expiration Date. | [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/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md new file mode 100644 index 00000000..6ac1028f --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md @@ -0,0 +1,14 @@ +# TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | This field contains the issuer name. | [optional] +**country** | **str** | This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. | [optional] +**bin_length** | **str** | This field contains the length of the BIN. | [optional] +**phone_number** | **str** | This field contains the customer service phone number for the issuer. | [optional] +**transaction_information** | **str** | In a Mastercard Transaction, this field contains the unique identifier (Transaction Link ID) for the first transaction in a transaction life cycle. This ID is crucial for maintaining continuity and linking subsequent operations to the original 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/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md new file mode 100644 index 00000000..e320d2e2 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponsePaymentInformationNetwork + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | This field contains a code that identifies the network. Please refer [Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_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/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md new file mode 100644 index 00000000..b0c556f5 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md @@ -0,0 +1,12 @@ +# TssV2TransactionsGet200ResponsePaymentInformationPaymentType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank, KCP) - `localCard` (KCP Local card via Altpay) - `carrierBilling` (KCP Carrier Billing via Altpay) | [optional] +**type** | **str** | Indicates the payment type used in this payment transaction. Example: credit card, check | [optional] +**method** | **str** | Indicates the payment method used in this payment 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/TssV2TransactionsGet200ResponsePayoutOptions.md b/docs/TssV2TransactionsGet200ResponsePayoutOptions.md new file mode 100644 index 00000000..94958769 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePayoutOptions.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponsePayoutOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payout_inquiry** | **str** | If true then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup. Possible values: - `true` - `false` | [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/TssV2TransactionsGet200ResponsePointOfSaleInformation.md b/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md new file mode 100644 index 00000000..1da6c9bc --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md @@ -0,0 +1,14 @@ +# TssV2TransactionsGet200ResponsePointOfSaleInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terminal_id** | **str** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional] +**entry_mode** | **str** | Method of entering payment card information into the POS terminal. Possible values: - `contact`: Read from direct contact with chip card. - `contactless`: Read from a contactless interface using chip data. - `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - `swiped`: Read from credit card magnetic stripe. The `contact`, `contactless`, and `msd` values are supported only for EMV transactions. #### Used by **Authorization** Required field. #### Card Present Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. #### PIN debit Required for a PIN debit purchase and a PIN debit credit request. | [optional] +**terminal_capability** | **int** | POS terminal's capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards. - `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be `4` or `5`. #### PIN debit Required for PIN debit purchase and PIN debit credit request. #### Used by **Authorization** Required for the following processors: - American Express Direct - Chase Paymentech Solutions - Credit Mutuel-CIC - FDC Nashville Global - FDMS Nashville - OmniPay Direct - SIX - Worldpay VAP Optional for the following processors: - CyberSource through VisaNet - GPN - GPX - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions | [optional] +**cardholder_verification_method_used** | **int** | Method that was used to verify the cardholder's identity. Possible values: - `0`: No verification - `1`: Signature - `2`: PIN - `3`: Cardholder device CVM - `4`: Biometric - `5`: OTP | [optional] +**emv** | [**Ptsv2paymentsidreversalsPointOfSaleInformationEmv**](Ptsv2paymentsidreversalsPointOfSaleInformationEmv.md) | | [optional] + +[[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/TssV2TransactionsGet200ResponseProcessingInformation.md b/docs/TssV2TransactionsGet200ResponseProcessingInformation.md new file mode 100644 index 00000000..80f86f89 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformation.md @@ -0,0 +1,21 @@ +# TssV2TransactionsGet200ResponseProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bin_source** | **str** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional] +**industry_data_type** | **str** | 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] +**payment_solution** | **str** | Type of digital payment solution for the transaction. | [optional] +**commerce_indicator** | **str** | 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] +**commerce_indicator_label** | **str** | 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] +**business_application_id** | **str** | Required for AFT and OCT transactions. Given below is a list of all the BAI values available. However, the processors may support only few specific BAI values. - AA : Account-to-account - BB : Supplier Payments - BI : Bank-Initiated P2P Money Transfer - BP : Non-Card Bill Pay/Bill Pay - CD : Cash Deposit - CP : Credit card Bill Payment - FD : Funds disbursement - FT : Funds transfer - GD : Government Disbursement - GP : Gambling payout (non-online gambling) - LO : Loyalty credits and rebates - MD : Merchant Settlement - OG : Online Gambling Payout - PD : Payroll and pension disbursement - PP : Person-to-Person or Peer-to-Peer - TU : Top up, prepaid load - WT : Digital wallet | [optional] +**authorization_options** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md) | | [optional] +**bank_transfer_options** | [**TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions**](TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md) | | [optional] +**capture_options** | [**TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions**](TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md) | | [optional] +**reconciliation_id** | **str** | 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] +**japan_payment_options** | [**TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions**](TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md) | | [optional] +**validation_level** | **int** | Enter 1 for routing and account number validation. | [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/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md new file mode 100644 index 00000000..68a500bc --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md @@ -0,0 +1,14 @@ +# TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auth_type** | **str** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. #### for PayPal ptsV2CreateOrderPost400Response Set this field to 'AUTHORIZE' or 'CAPTURE' depending on whether you want to invoke delayed capture or sale respectively. | [optional] +**auth_indicator** | **str** | 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] +**extend_auth_indicator** | **str** | Indicates Authorization extension transaction. Extension transaction is used to prolong the settlement period by one additional settlement cycle period. Possible values: - true: Transaction is an Authorization Extension transaction. - false: Transaction is not an Authorization Extension transaction. | [optional] +**card_verification_indicator** | **bool** | This API field will indicate whether a card verification check is being performed during the transaction Possible values: - `true` - `false` (default value) | [optional] +**initiator** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] + +[[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/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md new file mode 100644 index 00000000..8d5f4696 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md @@ -0,0 +1,13 @@ +# TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** | [optional] +**credential_stored_on_file** | **str** | 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: - `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `N` 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] +**stored_credential_used** | **str** | Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file. Possible values: - **Y** means the merchant-initiated transaction came from a card that was already stored on file. - **N** means the merchant-initiated transaction came from a card that was not stored on file. | [optional] +**merchant_initiated_transaction** | [**MerchantInitiatedTransactionObject**](MerchantInitiatedTransactionObject.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/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md new file mode 100644 index 00000000..4acf0adc --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sec_code** | **str** | Specifies the authorization method for the transaction. Possible values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry | [optional] + +[[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/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md new file mode 100644 index 00000000..3f86bbc9 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_capture_count** | **int** | Total number of captures when requesting multiple partial captures for one payment. Used along with `captureSequenceNumber` field to track which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - `captureSequenceNumber = 2`, and - `totalCaptureCount = 5` | [optional] +**capture_sequence_number** | **int** | Capture number when requesting multiple partial captures for one authorization. Used along with `totalCaptureCount` to track which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - `captureSequenceNumber_ = 2`, and - `totalCaptureCount = 5` | [optional] + +[[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/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md new file mode 100644 index 00000000..e06856a9 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions.md @@ -0,0 +1,18 @@ +# TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_method** | **str** | This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment) | [optional] +**terminal_id** | **str** | Unique Japan Credit Card Association (JCCA) terminal identifier. The difference between this field and the `pointOfSaleInformation.terminalID` field is that you can define `pointOfSaleInformation.terminalID`, but `processingInformation.japanPaymentOptions.terminalId` is defined by the JCCA and is used only in Japan. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field. | [optional] +**business_name** | **str** | Business name in Japanese characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional] +**business_name_katakana** | **str** | Business name in Katakana characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional] +**business_name_english** | **str** | Business name in English characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. | [optional] +**bonuses** | [**list[Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses]**](Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses.md) | An array of objects, each of which contains a bonus month and bonus amount. Length of bonuses array is equal to the number of bonuses. Max length = 6. In case of bonus month and amount not specified, null objects to be returned in the array. Example: bonuses : [ {\"month\": \"1\",\"amount\": \"200\"}, {\"month\": \"3\",\"amount\": \"2500\"}, null] | [optional] +**first_billing_month** | **str** | Billing month in MM format. | [optional] +**number_of_installments** | **str** | Number of Installments. | [optional] +**pre_approval_type** | **str** | This will contain the details of the kind of transaction that has been processe. Used only for Japan. Possible Values: - 0 = Normal (authorization with amount and clearing/settlement; data capture or paper draft) - 1 = Negative card authorization (authorization-only with 0 or 1 amount) - 2 = Reservation of authorization (authorization-only with amount) - 3 = Cancel transaction - 4 = Merchant-initiated reversal/refund transactions - 5 = Cancel reservation of authorization - 6 = Post authorization | [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/TssV2TransactionsGet200ResponseProcessorInformation.md b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md new file mode 100644 index 00000000..86d43c00 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md @@ -0,0 +1,26 @@ +# TssV2TransactionsGet200ResponseProcessorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processor** | [**TssV2TransactionsGet200ResponseProcessorInformationProcessor**](TssV2TransactionsGet200ResponseProcessorInformationProcessor.md) | | [optional] +**multi_processor_routing** | [**list[TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting]**](TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md) | An array of object that contains the list of acquirer response codes & reasons if a transaction is routed to multiple acquirers. | [optional] +**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] +**network_transaction_id** | **str** | Same value as `processorInformation.transactionId` | [optional] +**retrieval_reference_number** | **str** | #### Ingenico ePayments Unique number that CyberSource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report. ### CyberSource through VisaNet Retrieval request number. | [optional] +**response_id** | **str** | Response ID sent from the processor. | [optional] +**approval_code** | **str** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional] +**response_code** | **str** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail. | [optional] +**avs** | [**PtsV2PaymentsPost201ResponseProcessorInformationAvs**](PtsV2PaymentsPost201ResponseProcessorInformationAvs.md) | | [optional] +**card_verification** | [**Riskv1decisionsProcessorInformationCardVerification**](Riskv1decisionsProcessorInformationCardVerification.md) | | [optional] +**ach_verification** | [**PtsV2PaymentsPost201ResponseProcessorInformationAchVerification**](PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md) | | [optional] +**electronic_verification_results** | [**TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults**](TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md) | | [optional] +**event_status** | **str** | The event status. | [optional] +**system_trace_audit_number** | **str** | This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer's receipt. | [optional] +**response_code_source** | **str** | Used by Visa only and contains the response source/reason code that identifies the source of the response decision. | [optional] +**payment_account_reference_number** | **str** | Payment Account Reference (PAR) is a non-financial reference assigned to each unique payment account and used to link a payment account to associated network tokens, i.e. the same PAR is returned for PAN-based and tokenized transactions, such as from digital wallets. PAR can be returned in authorisation responses for requests initiated with both real PANs and tokenized PANs. PAR can be used by merchants for fraud detection and regulatory compliance across different channels and digital wallets. PAR allows all participants in the payments chain to have a single, non-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder identification fields, and transmitted across the payments ecosystem to facilitate card holder identification. **Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR8 - Position: 79-110 - Field: Payment Account Reference The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. | [optional] +**routing** | [**PtsV2PaymentsPost201ResponseProcessorInformationRouting**](PtsV2PaymentsPost201ResponseProcessorInformationRouting.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/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md new file mode 100644 index 00000000..0875a3ee --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md @@ -0,0 +1,19 @@ +# TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | Mapped Electronic Verification response code for the customer's email address. | [optional] +**email_raw** | **str** | Raw Electronic Verification response code from the processor for the customer's email address. | [optional] +**name** | **str** | #### 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] +**name_raw** | **str** | #### 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] +**phone_number** | **str** | Mapped Electronic Verification response code for the customer's phone number. | [optional] +**phone_number_raw** | **str** | Raw Electronic Verification response code from the processor for the customer's phone number. | [optional] +**street** | **str** | Mapped Electronic Verification response code for the customer's street address. | [optional] +**street_raw** | **str** | Raw Electronic Verification response code from the processor for the customer's street address. | [optional] +**postal_code** | **str** | Mapped Electronic Verification response code for the customer's postal code. | [optional] +**postal_code_raw** | **str** | 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/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md new file mode 100644 index 00000000..d3b2f945 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md @@ -0,0 +1,13 @@ +# TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Processor. | [optional] +**response_code** | **str** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail. | [optional] +**reason_code** | **str** | Indicates the reason why a request succeeded or failed and possible action to take if a request fails. For details, see the appendix of reason codes in the documentation for the relevant payment method. | [optional] +**sequence** | **str** | The order in which the transaction was routed to the 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/TssV2TransactionsGet200ResponseProcessorInformationProcessor.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationProcessor.md new file mode 100644 index 00000000..7092c2ec --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformationProcessor.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponseProcessorInformationProcessor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the 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/TssV2TransactionsGet200ResponseRecurringPaymentInformation.md b/docs/TssV2TransactionsGet200ResponseRecurringPaymentInformation.md new file mode 100644 index 00000000..7025c592 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseRecurringPaymentInformation.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponseRecurringPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_type** | **str** | Indicates recurring amount type agreed by the cardholder Valid Values : 1- Fixed amount recurring payment 2- Recurring payment with maximum amount | [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/TssV2TransactionsGet200ResponseRiskInformation.md b/docs/TssV2TransactionsGet200ResponseRiskInformation.md new file mode 100644 index 00000000..5bfbe2d8 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseRiskInformation.md @@ -0,0 +1,15 @@ +# TssV2TransactionsGet200ResponseRiskInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**profile** | [**TssV2TransactionsGet200ResponseRiskInformationProfile**](TssV2TransactionsGet200ResponseRiskInformationProfile.md) | | [optional] +**rules** | [**list[TssV2TransactionsGet200ResponseRiskInformationRules]**](TssV2TransactionsGet200ResponseRiskInformationRules.md) | | [optional] +**passive_profile** | [**TssV2TransactionsGet200ResponseRiskInformationProfile**](TssV2TransactionsGet200ResponseRiskInformationProfile.md) | | [optional] +**passive_rules** | [**list[TssV2TransactionsGet200ResponseRiskInformationRules]**](TssV2TransactionsGet200ResponseRiskInformationRules.md) | | [optional] +**score** | [**TssV2TransactionsGet200ResponseRiskInformationScore**](TssV2TransactionsGet200ResponseRiskInformationScore.md) | | [optional] +**local_time** | **str** | Time that the transaction was submitted in local time. Generated by Cybersource. | [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/TssV2TransactionsGet200ResponseRiskInformationProfile.md b/docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md new file mode 100644 index 00000000..b2618333 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseRiskInformationProfile + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the profile. | [optional] +**decision** | **str** | Decision returned by the profile; this field contains one of these values: - ACCEPT - REJECT - REVIEW | [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/TssV2TransactionsGet200ResponseRiskInformationRules.md b/docs/TssV2TransactionsGet200ResponseRiskInformationRules.md new file mode 100644 index 00000000..a66901d5 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseRiskInformationRules.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseRiskInformationRules + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Description of the rule as it appears in the Profile Editor. | [optional] +**decision** | **str** | Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` | [optional] + +[[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/TssV2TransactionsGet200ResponseRiskInformationScore.md b/docs/TssV2TransactionsGet200ResponseRiskInformationScore.md new file mode 100644 index 00000000..a22ed99b --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseRiskInformationScore.md @@ -0,0 +1,11 @@ +# TssV2TransactionsGet200ResponseRiskInformationScore + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**factor_codes** | **list[str]** | Array of factor codes. | [optional] +**result** | **int** | The description for this field is not available. | [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/TssV2TransactionsGet200ResponseSenderInformation.md b/docs/TssV2TransactionsGet200ResponseSenderInformation.md new file mode 100644 index 00000000..23a18cf8 --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseSenderInformation.md @@ -0,0 +1,10 @@ +# TssV2TransactionsGet200ResponseSenderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reference_number** | **str** | Reference number generated by you that uniquely identifies the sender. | [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/TssV2TransactionsGet200ResponseTokenInformation.md b/docs/TssV2TransactionsGet200ResponseTokenInformation.md new file mode 100644 index 00000000..0b6d5c2b --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseTokenInformation.md @@ -0,0 +1,15 @@ +# TssV2TransactionsGet200ResponseTokenInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer** | [**PtsV2PaymentsPost201ResponseTokenInformationCustomer**](PtsV2PaymentsPost201ResponseTokenInformationCustomer.md) | | [optional] +**payment_instrument** | [**PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument**](PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument.md) | | [optional] +**shipping_address** | [**PtsV2PaymentsPost201ResponseTokenInformationShippingAddress**](PtsV2PaymentsPost201ResponseTokenInformationShippingAddress.md) | | [optional] +**instrument_identifier** | [**TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier**](TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md) | | [optional] +**jti** | **str** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [optional] +**transient_token_jwt** | **str** | Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. | [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/TssV2TransactionsPost201Response.md b/docs/TssV2TransactionsPost201Response.md new file mode 100644 index 00000000..9e3c668d --- /dev/null +++ b/docs/TssV2TransactionsPost201Response.md @@ -0,0 +1,22 @@ +# TssV2TransactionsPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**search_id** | **str** | An unique identification number assigned by CyberSource to identify each Search request. | [optional] +**save** | **bool** | Indicates whether or not you want to save this search request for future use. The options are: * `true` * `false` (default value) If set to `true`, this field returns `searchID` in the response. You can use this value to retrieve the details of the saved search. | [optional] +**name** | **str** | Name of this search. When `save` is set to `true`, this search is saved with this name. | [optional] +**timezone** | **str** | Merchant's time zone in ISO standard, using the TZ database format. For example: `America/Chicago` | [optional] +**query** | **str** | String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn-search-intro/txn-filtering.html) section of the Transaction Search Developer Guide. | [optional] +**offset** | **int** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional] +**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional] +**sort** | **str** | A comma separated list of the following form: `submitTimeUtc:desc` | [optional] +**count** | **int** | Results for this page, this could be below the limit. | [optional] +**total_count** | **int** | Total number of results. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**embedded** | [**TssV2TransactionsPost201ResponseEmbedded**](TssV2TransactionsPost201ResponseEmbedded.md) | | [optional] +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.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/TssV2TransactionsPost201ResponseEmbedded.md b/docs/TssV2TransactionsPost201ResponseEmbedded.md new file mode 100644 index 00000000..4920dc0f --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbedded.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction_summaries** | [**list[TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries]**](TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md) | transaction search summary | [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/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md new file mode 100644 index 00000000..7802a2f2 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md @@ -0,0 +1,14 @@ +# TssV2TransactionsPost201ResponseEmbeddedApplicationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason_code** | **str** | Indicates the reason why a request succeeded or failed and possible action to take if a request fails. For details, see the appendix of reason codes in the documentation for the relevant payment method. | [optional] +**r_code** | **str** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional] +**r_flag** | **str** | One-word description of the result of the application. | [optional] +**applications** | [**list[TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications]**](TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md) | | [optional] +**return_code** | **int** | The description for this field is not available. | [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/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md b/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md new file mode 100644 index 00000000..d3bb28fd --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md @@ -0,0 +1,18 @@ +# TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the CyberSource transaction type (such as CC settlement or CC authorization) that the merchant wants to process in a transaction request. More than one transaction type can included in a transaction request. Each transaction type separately returns their own status, reasonCode, rCode, and rFlag messages. | [optional] +**reason_code** | **str** | 3-digit reason code that indicates why the customer profile payment succeeded or failed. | [optional] +**status** | **str** | The status of the submitted transaction. Note: This field may not be returned for all transactions. | [optional] +**reason** | **str** | Description of why a request failed. Note: This field may not be returned for all transactions. | [optional] +**r_code** | **str** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional] +**r_flag** | **str** | One-word description of the result of the application. | [optional] +**reconciliation_id** | **str** | Reference number that you use to reconcile your CyberSource reports with your processor reports. | [optional] +**r_message** | **str** | Message that explains the reply flag for the application. | [optional] +**return_code** | **int** | The description for this field is not available. | [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/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md new file mode 100644 index 00000000..263efc80 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md @@ -0,0 +1,13 @@ +# TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | 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] +**application_name** | **str** | 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] +**application_user** | **str** | 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. | [optional] +**partner** | [**TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner**](TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.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/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md new file mode 100644 index 00000000..c828f209 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**solution_id** | **str** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [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/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md new file mode 100644 index 00000000..2eb96f4b --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md @@ -0,0 +1,12 @@ +# TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**xid** | **str** | Transaction identifier. | [optional] +**transaction_id** | **str** | Payer auth Transaction identifier. | [optional] +**eci_raw** | **str** | 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/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md new file mode 100644 index 00000000..985519f9 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbeddedErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | Description of why a request failed. Note: This field may not be returned for all 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/TssV2TransactionsPost201ResponseEmbeddedLinks.md b/docs/TssV2TransactionsPost201ResponseEmbeddedLinks.md new file mode 100644 index 00000000..ff124501 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedLinks.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbeddedLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction_detail** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.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/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md new file mode 100644 index 00000000..08490716 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbeddedMerchantInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reseller_id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] + +[[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/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md new file mode 100644 index 00000000..48ec09dc --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md @@ -0,0 +1,12 @@ +# TssV2TransactionsPost201ResponseEmbeddedOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bill_to** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo**](TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md) | | [optional] +**ship_to** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo**](TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md) | | [optional] +**amount_details** | [**Ptsv2paymentsidreversalsReversalInformationAmountDetails**](Ptsv2paymentsidreversalsReversalInformationAmountDetails.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/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md new file mode 100644 index 00000000..00743f2f --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md @@ -0,0 +1,15 @@ +# TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | 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] +**last_name** | **str** | 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** | **str** | 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** | **str** | 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** | **str** | 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] +**phone_number** | **str** | 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/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md new file mode 100644 index 00000000..d29034da --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md @@ -0,0 +1,14 @@ +# TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] +**last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] +**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**phone_number** | **str** | Phone number associated with the shipping 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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md new file mode 100644 index 00000000..ce93c8bb --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md @@ -0,0 +1,13 @@ +# TssV2TransactionsPost201ResponseEmbeddedPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_type** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md) | | [optional] +**customer** | [**Ptsv2refreshpaymentstatusidPaymentInformationCustomer**](Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md) | | [optional] +**card** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md) | | [optional] +**bank** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.md new file mode 100644 index 00000000..4c4fddc0 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBank + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.md new file mode 100644 index 00000000..78cfd686 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount.md @@ -0,0 +1,11 @@ +# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationBankAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**suffix** | **str** | Last four digits of the customer's payment account number. | [optional] +**prefix** | **str** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. | [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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md new file mode 100644 index 00000000..f70112b8 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md @@ -0,0 +1,12 @@ +# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**suffix** | **str** | Last four digits of the cardholder's account number. This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### PIN debit This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. Returned by PIN debit credit and PIN debit purchase. This field is supported only by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional] +**prefix** | **str** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional] +**type** | **str** | 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. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md new file mode 100644 index 00000000..5b28c236 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md @@ -0,0 +1,11 @@ +# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Indicates the payment type used in this payment transaction. Example: credit card, check | [optional] +**method** | **str** | Indicates the payment method used in this payment 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/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md new file mode 100644 index 00000000..203adbc2 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md @@ -0,0 +1,14 @@ +# TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terminal_id** | **str** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional] +**terminal_serial_number** | **str** | Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional] +**device_id** | **str** | Value created by the client software that uniquely identifies the POS device. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only for authorizations and credits on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field. String (32) | [optional] +**partner** | [**TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner**](TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md) | | [optional] +**emv** | [**Ptsv2paymentsidreversalsPointOfSaleInformationEmv**](Ptsv2paymentsidreversalsPointOfSaleInformationEmv.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/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md new file mode 100644 index 00000000..2923c9ad --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**original_transaction_id** | **str** | Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal's software and to CyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's software. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. | [optional] + +[[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/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md new file mode 100644 index 00000000..d11b8cfa --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md @@ -0,0 +1,13 @@ +# TssV2TransactionsPost201ResponseEmbeddedProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**business_application_id** | **str** | Required for AFT and OCT transactions. Given below is a list of all the BAI values available. However, the processors may support only few specific BAI values. - AA : Account-to-account - BB : Supplier Payments - BI : Bank-Initiated P2P Money Transfer - BP : Non-Card Bill Pay/Bill Pay - CD : Cash Deposit - CP : Credit card Bill Payment - FD : Funds disbursement - FT : Funds transfer - GD : Government Disbursement - GP : Gambling payout (non-online gambling) - LO : Loyalty credits and rebates - MD : Merchant Settlement - OG : Online Gambling Payout - PD : Payroll and pension disbursement - PP : Person-to-Person or Peer-to-Peer - TU : Top up, prepaid load - WT : Digital wallet | [optional] +**commerce_indicator** | **str** | 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] +**commerce_indicator_label** | **str** | 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/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md new file mode 100644 index 00000000..c1362de9 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md @@ -0,0 +1,14 @@ +# TssV2TransactionsPost201ResponseEmbeddedProcessorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processor** | [**TssV2TransactionsGet200ResponseProcessorInformationProcessor**](TssV2TransactionsGet200ResponseProcessorInformationProcessor.md) | | [optional] +**provider_transaction_id** | **str** | Unique ID [codigo] generated by the processor for real-time payments processed directly by the Iugu processor. | [optional] +**approval_code** | **str** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional] +**event_status** | **str** | The event status. | [optional] +**retrieval_reference_number** | **str** | #### Ingenico ePayments Unique number that CyberSource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report. ### CyberSource through VisaNet Retrieval request number. | [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/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md new file mode 100644 index 00000000..a74145be --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbeddedRiskInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**providers** | [**TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders**](TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.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/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.md b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.md new file mode 100644 index 00000000..233b2cbe --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.md @@ -0,0 +1,10 @@ +# TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fingerprint** | [**TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint**](TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.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/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md new file mode 100644 index 00000000..64272039 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md @@ -0,0 +1,12 @@ +# TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**true_ipaddress** | **str** | Customer's true IP address detected by the application. For details, see the `true_ipaddress` field description in _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). | [optional] +**hash** | **str** | The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field. For more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). | [optional] +**smart_id** | **str** | The device identifier generated from attributes collected during profiling. Returned by a 3rd party when you use device fingerprinting. For details, see the `device_fingerprint_smart_id` field description in [CyberSource Decision Manager Device Fingerprinting Guide.](https://www.cybersource.com/developers/documentation/fraud_management) | [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/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md b/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md new file mode 100644 index 00000000..ce24ca40 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md @@ -0,0 +1,29 @@ +# TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**merchant_id** | **str** | Your CyberSource merchant ID. | [optional] +**status** | **str** | The status of the submitted transaction. Note: This field may not be returned for all transactions. | [optional] +**application_information** | [**TssV2TransactionsPost201ResponseEmbeddedApplicationInformation**](TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md) | | [optional] +**buyer_information** | [**PtsV2CreateOrderPost201ResponseBuyerInformation**](PtsV2CreateOrderPost201ResponseBuyerInformation.md) | | [optional] +**client_reference_information** | [**TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation**](TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md) | | [optional] +**consumer_authentication_information** | [**TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation**](TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md) | | [optional] +**device_information** | [**Riskv1authenticationresultsDeviceInformation**](Riskv1authenticationresultsDeviceInformation.md) | | [optional] +**error_information** | [**TssV2TransactionsPost201ResponseEmbeddedErrorInformation**](TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md) | | [optional] +**fraud_marking_information** | [**TssV2TransactionsGet200ResponseFraudMarkingInformation**](TssV2TransactionsGet200ResponseFraudMarkingInformation.md) | | [optional] +**merchant_defined_information** | [**list[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] +**merchant_information** | [**TssV2TransactionsPost201ResponseEmbeddedMerchantInformation**](TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md) | | [optional] +**order_information** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformation**](TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md) | | [optional] +**payment_information** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformation**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md) | | [optional] +**processing_information** | [**TssV2TransactionsPost201ResponseEmbeddedProcessingInformation**](TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md) | | [optional] +**processor_information** | [**TssV2TransactionsPost201ResponseEmbeddedProcessorInformation**](TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md) | | [optional] +**point_of_sale_information** | [**TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation**](TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md) | | [optional] +**risk_information** | [**TssV2TransactionsPost201ResponseEmbeddedRiskInformation**](TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md) | | [optional] +**links** | [**TssV2TransactionsPost201ResponseEmbeddedLinks**](TssV2TransactionsPost201ResponseEmbeddedLinks.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/Tssv2transactionsemvTagDetailsEmvDetailsList.md b/docs/Tssv2transactionsemvTagDetailsEmvDetailsList.md new file mode 100644 index 00000000..4f554e60 --- /dev/null +++ b/docs/Tssv2transactionsemvTagDetailsEmvDetailsList.md @@ -0,0 +1,11 @@ +# Tssv2transactionsemvTagDetailsEmvDetailsList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | +**emv_request_combined_tags** | **str** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) For Mastercard Transactions, Optionally Tag 9F60 (Authenticated Application Data) and Tag 96 (Kernel Identifier - Terminal) can be included in the Field. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): 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/UmsV1UsersGet200Response.md b/docs/UmsV1UsersGet200Response.md new file mode 100644 index 00000000..4ea1caa9 --- /dev/null +++ b/docs/UmsV1UsersGet200Response.md @@ -0,0 +1,10 @@ +# UmsV1UsersGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**users** | [**list[UmsV1UsersGet200ResponseUsers]**](UmsV1UsersGet200ResponseUsers.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/UmsV1UsersGet200ResponseAccountInformation.md b/docs/UmsV1UsersGet200ResponseAccountInformation.md new file mode 100644 index 00000000..607cc431 --- /dev/null +++ b/docs/UmsV1UsersGet200ResponseAccountInformation.md @@ -0,0 +1,17 @@ +# UmsV1UsersGet200ResponseAccountInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_name** | **str** | | [optional] +**role_id** | **str** | | [optional] +**permissions** | **list[str]** | | [optional] +**status** | **str** | Valid values: - active - inactive - locked - disabled - forgotpassword - deleted | [optional] +**created_time** | **datetime** | | [optional] +**last_access_time** | **datetime** | | [optional] +**language_preference** | **str** | | [optional] +**timezone** | **str** | | [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/UmsV1UsersGet200ResponseContactInformation.md b/docs/UmsV1UsersGet200ResponseContactInformation.md new file mode 100644 index 00000000..f4c6af63 --- /dev/null +++ b/docs/UmsV1UsersGet200ResponseContactInformation.md @@ -0,0 +1,13 @@ +# UmsV1UsersGet200ResponseContactInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | | [optional] +**phone_number** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [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/UmsV1UsersGet200ResponseOrganizationInformation.md b/docs/UmsV1UsersGet200ResponseOrganizationInformation.md new file mode 100644 index 00000000..c0456de5 --- /dev/null +++ b/docs/UmsV1UsersGet200ResponseOrganizationInformation.md @@ -0,0 +1,10 @@ +# UmsV1UsersGet200ResponseOrganizationInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [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/UmsV1UsersGet200ResponseUsers.md b/docs/UmsV1UsersGet200ResponseUsers.md new file mode 100644 index 00000000..cdeb1b75 --- /dev/null +++ b/docs/UmsV1UsersGet200ResponseUsers.md @@ -0,0 +1,13 @@ +# UmsV1UsersGet200ResponseUsers + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_information** | [**UmsV1UsersGet200ResponseAccountInformation**](UmsV1UsersGet200ResponseAccountInformation.md) | | [optional] +**organization_information** | [**UmsV1UsersGet200ResponseOrganizationInformation**](UmsV1UsersGet200ResponseOrganizationInformation.md) | | [optional] +**contact_information** | [**UmsV1UsersGet200ResponseContactInformation**](UmsV1UsersGet200ResponseContactInformation.md) | | [optional] +**custom_fields** | **dict(str, str)** | | [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/UnauthorizedClientError.md b/docs/UnauthorizedClientError.md new file mode 100644 index 00000000..ad201f61 --- /dev/null +++ b/docs/UnauthorizedClientError.md @@ -0,0 +1,11 @@ +# UnauthorizedClientError + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **str** | | [optional] +**error_description** | **str** | | [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/UnifiedCheckoutCaptureContextApi.md b/docs/UnifiedCheckoutCaptureContextApi.md new file mode 100644 index 00000000..5a95a478 --- /dev/null +++ b/docs/UnifiedCheckoutCaptureContextApi.md @@ -0,0 +1,57 @@ +# CyberSource.UnifiedCheckoutCaptureContextApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**generate_unified_checkout_capture_context**](UnifiedCheckoutCaptureContextApi.md#generate_unified_checkout_capture_context) | **POST** /up/v1/capture-contexts | Generate Unified Checkout Capture Context + + +# **generate_unified_checkout_capture_context** +> str generate_unified_checkout_capture_context(generate_unified_checkout_capture_context_request) + +Generate Unified Checkout Capture Context + +Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.UnifiedCheckoutCaptureContextApi() +generate_unified_checkout_capture_context_request = CyberSource.GenerateUnifiedCheckoutCaptureContextRequest() # GenerateUnifiedCheckoutCaptureContextRequest | + +try: + # Generate Unified Checkout Capture Context + api_response = api_instance.generate_unified_checkout_capture_context(generate_unified_checkout_capture_context_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling UnifiedCheckoutCaptureContextApi->generate_unified_checkout_capture_context: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **generate_unified_checkout_capture_context_request** | [**GenerateUnifiedCheckoutCaptureContextRequest**](GenerateUnifiedCheckoutCaptureContextRequest.md)| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/jwt + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UpdateInvoiceRequest.md b/docs/UpdateInvoiceRequest.md new file mode 100644 index 00000000..fdbb4d56 --- /dev/null +++ b/docs/UpdateInvoiceRequest.md @@ -0,0 +1,13 @@ +# UpdateInvoiceRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer_information** | [**Invoicingv2invoicesCustomerInformation**](Invoicingv2invoicesCustomerInformation.md) | | [optional] +**processing_information** | [**Invoicingv2invoicesProcessingInformation**](Invoicingv2invoicesProcessingInformation.md) | | [optional] +**invoice_information** | [**Invoicingv2invoicesidInvoiceInformation**](Invoicingv2invoicesidInvoiceInformation.md) | | +**order_information** | [**Invoicingv2invoicesOrderInformation**](Invoicingv2invoicesOrderInformation.md) | | + +[[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/UpdateOrderRequest.md b/docs/UpdateOrderRequest.md new file mode 100644 index 00000000..854f7b7c --- /dev/null +++ b/docs/UpdateOrderRequest.md @@ -0,0 +1,14 @@ +# UpdateOrderRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Ptsv2intentsClientReferenceInformation**](Ptsv2intentsClientReferenceInformation.md) | | [optional] +**order_information** | [**Ptsv2intentsidOrderInformation**](Ptsv2intentsidOrderInformation.md) | | [optional] +**merchant_information** | [**Ptsv2intentsidMerchantInformation**](Ptsv2intentsidMerchantInformation.md) | | [optional] +**payment_information** | [**Ptsv2intentsidPaymentInformation**](Ptsv2intentsidPaymentInformation.md) | | [optional] +**processing_information** | [**Ptsv2intentsidProcessingInformation**](Ptsv2intentsidProcessingInformation.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/UpdatePaymentLinkRequest.md b/docs/UpdatePaymentLinkRequest.md new file mode 100644 index 00000000..c4ef3978 --- /dev/null +++ b/docs/UpdatePaymentLinkRequest.md @@ -0,0 +1,14 @@ +# UpdatePaymentLinkRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | The status of the purchase or donation link. Possible values: - ACTIVE - INACTIVE | [optional] +**client_reference_information** | [**Invoicingv2invoicesClientReferenceInformation**](Invoicingv2invoicesClientReferenceInformation.md) | | [optional] +**processing_information** | [**Iplv2paymentlinksidProcessingInformation**](Iplv2paymentlinksidProcessingInformation.md) | | [optional] +**purchase_information** | [**Iplv2paymentlinksidPurchaseInformation**](Iplv2paymentlinksidPurchaseInformation.md) | | [optional] +**order_information** | [**Iplv2paymentlinksidOrderInformation**](Iplv2paymentlinksidOrderInformation.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/UpdatePlanRequest.md b/docs/UpdatePlanRequest.md new file mode 100644 index 00000000..30ee7e67 --- /dev/null +++ b/docs/UpdatePlanRequest.md @@ -0,0 +1,12 @@ +# UpdatePlanRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**plan_information** | [**Rbsv1plansidPlanInformation**](Rbsv1plansidPlanInformation.md) | | [optional] +**processing_information** | [**Rbsv1plansidProcessingInformation**](Rbsv1plansidProcessingInformation.md) | | [optional] +**order_information** | [**GetAllPlansResponseOrderInformation**](GetAllPlansResponseOrderInformation.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/UpdatePlanResponse.md b/docs/UpdatePlanResponse.md new file mode 100644 index 00000000..b4e5cd1e --- /dev/null +++ b/docs/UpdatePlanResponse.md @@ -0,0 +1,14 @@ +# UpdatePlanResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - COMPLETED | [optional] +**plan_information** | [**UpdatePlanResponsePlanInformation**](UpdatePlanResponsePlanInformation.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/UpdatePlanResponsePlanInformation.md b/docs/UpdatePlanResponsePlanInformation.md new file mode 100644 index 00000000..9d14dfcb --- /dev/null +++ b/docs/UpdatePlanResponsePlanInformation.md @@ -0,0 +1,11 @@ +# UpdatePlanResponsePlanInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Plan code | [optional] +**status** | **str** | Plan Status: - `DRAFT` - `ACTIVE` - `INACTIVE` | [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/UpdateStatus.md b/docs/UpdateStatus.md new file mode 100644 index 00000000..f141e189 --- /dev/null +++ b/docs/UpdateStatus.md @@ -0,0 +1,10 @@ +# UpdateStatus + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | The status the user intends to update the subscription to. The supported values are ACTIVE & INACTIVE. If the subscription status is INACTIVE, webhook notifications will not be sent. Webhooks will resume being sent once the subscription is ACTIVE again. Possible values: - ACTIVE - INACTIVE | [optional] [default to 'INACTIVE'] + +[[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/UpdateSubscription.md b/docs/UpdateSubscription.md new file mode 100644 index 00000000..7ec003eb --- /dev/null +++ b/docs/UpdateSubscription.md @@ -0,0 +1,14 @@ +# UpdateSubscription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Rbsv1subscriptionsClientReferenceInformation**](Rbsv1subscriptionsClientReferenceInformation.md) | | [optional] +**processing_information** | [**Rbsv1subscriptionsProcessingInformation**](Rbsv1subscriptionsProcessingInformation.md) | | [optional] +**plan_information** | [**Rbsv1subscriptionsidPlanInformation**](Rbsv1subscriptionsidPlanInformation.md) | | [optional] +**subscription_information** | [**Rbsv1subscriptionsidSubscriptionInformation**](Rbsv1subscriptionsidSubscriptionInformation.md) | | [optional] +**order_information** | [**Rbsv1subscriptionsidOrderInformation**](Rbsv1subscriptionsidOrderInformation.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/UpdateSubscriptionResponse.md b/docs/UpdateSubscriptionResponse.md new file mode 100644 index 00000000..70980b86 --- /dev/null +++ b/docs/UpdateSubscriptionResponse.md @@ -0,0 +1,14 @@ +# UpdateSubscriptionResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**GetAllSubscriptionsResponseLinks**](GetAllSubscriptionsResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - COMPLETED - PENDING_REVIEW - DECLINED - INVALID_REQUEST | [optional] +**subscription_information** | [**CreateSubscriptionResponseSubscriptionInformation**](CreateSubscriptionResponseSubscriptionInformation.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/UpdateWebhook.md b/docs/UpdateWebhook.md new file mode 100644 index 00000000..d4f7f788 --- /dev/null +++ b/docs/UpdateWebhook.md @@ -0,0 +1,17 @@ +# UpdateWebhook + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Client friendly webhook name. | [optional] +**organization_id** | **str** | Organization Id. | [optional] +**description** | **str** | Client friendly webhook description. | [optional] +**products** | [**list[Notificationsubscriptionsv2webhooksProducts]**](Notificationsubscriptionsv2webhooksProducts.md) | | [optional] +**webhook_url** | **str** | The client's endpoint (URL) to receive webhooks. | [optional] +**notification_scope** | **str** | The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. This field is optional. Possible values: - SELF - DESCENDANTS | [optional] [default to 'DESCENDANTS'] +**health_check_url** | **str** | The client's health check endpoint (URL). | [optional] +**security_policy** | [**Notificationsubscriptionsv2webhooksSecurityPolicy**](Notificationsubscriptionsv2webhooksSecurityPolicy.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/Upv1capturecontextsCaptureMandate.md b/docs/Upv1capturecontextsCaptureMandate.md new file mode 100644 index 00000000..61caa199 --- /dev/null +++ b/docs/Upv1capturecontextsCaptureMandate.md @@ -0,0 +1,19 @@ +# Upv1capturecontextsCaptureMandate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**billing_type** | **str** | Configure Unified Checkout to capture billing address information. Possible values: - FULL: Capture complete billing address information. - PARTIAL: Capture first name, last name, country and postal/zip code only. - NONE: Capture only first name and last name. | [optional] +**request_email** | **bool** | Configure Unified Checkout to capture customer email address. Possible values: - True - False | [optional] +**request_phone** | **bool** | Configure Unified Checkout to capture customer phone number. Possible values: - True - False | [optional] +**request_shipping** | **bool** | Configure Unified Checkout to capture customer shipping details. Possible values: - True - False | [optional] +**ship_to_countries** | **list[str]** | List of countries available to ship to. Use the two-character ISO Standard Country Codes. | [optional] +**show_accepted_network_icons** | **bool** | Configure Unified Checkout to display the list of accepted card networks beneath the payment button Possible values: - True - False | [optional] +**show_confirmation_step** | **bool** | Configure Unified Checkout to display the final confirmation screen when using Click to Pay.<br> Where 'BillingType'= NONE and 'requestShipping'= FALSE and the customer is using an existing Click to Pay card as their chosen payment method, a final confirmation screen can be removed allowing the customer to check out as soon as they have selected their payment method from within their Click to Pay card tray. Possible values: - True - False | [optional] +**request_save_card** | **bool** | Configure Unified Checkout to display the \"Save card for future use\" checkbox.<br> Configurable check box that will show in a Manual card entry flow to allow a Cardholder to give consent to store their manually entered credential with the Merchant that they are paying.<br> Applicable when manually entering the details and not enrolling in Click to Pay. Possible values: - True - False<br><br> **Use Cases:** **Offer consumers option to save their card in Unified Checkout:** - Include the captureMandate.requestSaveCard field in the capture context request and set it to true. - When set to true, this will show a checkbox with the message 'Save card for future use' in Unified Checkout. - When selected this provides a response in both the Transient Token and Get Credentials API response.<br><br> **Do not offer consumers the option to save their card in Unified Checkout:** - Include the captureMandate.requestSaveCard field in the capture context request and set it to false OR omit the field from the capture context request. - When set to false, the save card option is not shown to consumers when manually entering card details. | [optional] +**combo_card** | **bool** | Configure Unified Checkout to display combo card at checkout.<br> A combo debit/credit card is a single card that functions both as a Debit/Credit card. Unified Checkout / Click to Pay Drop-in UI allows the Cardholder to choose whether they would like the transaction to be paid for using either debit or credit card. **Important:** This is applicable to Visa cards only. Possible values: - True - False<br><br> **Use Cases:** **Offer Combo Card at Checkout:** - Include the captureMandate.comboCard field in the capture context request and set it to true. - When set to true, Combo Card selection is shown at checkout <br><br> **Do not offer Combo Card at Checkout:** - Include the captureMandate.comboCard field in the capture context request and set it to false OR omit the field from the capture context request. - The Combo Card selection is not shown at checkout. | [optional] +**cpf** | **bool** | Configure Unified Checkout to display and capture the CPF number (Cadastro de Pessoas Físicas). The CPF number is a unique 11-digit identifier issued to Brazilian citizens and residents for tax purposes. Possible values: - True - False<br><br> This field is optional. If set to true the field is required. If set to false the field is optional. If the field is not included in the capture context then it is not captured.<br><br> **Important:** - If PANENTRY is specified in the allowedPaymentTypes field, the CPF number will be displayed in Unified Checkout regardless of what card number is entered. - If CLICKTOPAY is specified in the allowedPaymentTypes field, the CPF number will be displayed in Unified Checkout only when a Visa Click To Pay card is entered. | [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/Upv1capturecontextsCompleteMandate.md b/docs/Upv1capturecontextsCompleteMandate.md new file mode 100644 index 00000000..8fddd15e --- /dev/null +++ b/docs/Upv1capturecontextsCompleteMandate.md @@ -0,0 +1,12 @@ +# Upv1capturecontextsCompleteMandate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | This field is used to indicate how a payment should be processed. Possible values: - AUTH: Use this value when you want to authorize a payment within Unified Checkout without capturing it immediately. Payment types that initiate an immediate transfer of funds are NOT allowed. If a capture context request includes a payment type incompatible with this mode, a 400 error will be returned. A merchant would need to perform their own capture via API where applicable.<br><br> - CAPTURE: Use this value when you want to perform a sale within Unified Checkout and capture the payment immediately during the transaction. Note: Some payment types may return a PENDING status, requiring an additional status check call to determine the final outcome of the payment.<br><br> - PREFER_AUTH: Use this value to offer multiple alternative payment options during the Unified Checkout experience. This option authorizes the payment without immediate capture, where available. It will perform a \"CAPTURE\" where an \"AUTH\" is not allowed by the payment type. Transactions can be AUTHORIZED, CAPTURED, or PENDING. If an \"AUTH\" is performed, a merchant would need to perform their own capture via API where applicable. | [optional] +**decision_manager** | **bool** | Configure Unified Checkout to determine whether Decision Manager is invoked during service orchestration. Possible values: - True - False<br><br> Setting this value to True indicates that device fingerprinting will be executed to add additional information for risk service Setting this value to False (or not provided) indicates that you do not wish to run device fingerprinting and skip decision manager services. | [optional] +**consumer_authentication** | **bool** | Configure Unified Checkout to determine whether Consumer Authentication is invoked during service orchestration. Possible values: - True - False<br><br> Setting this value to True will attempt to perform authentication using the Payer Authentication Service. Setting this value to False (or not provided) indicates that you do not wish to perform authentication using the Payer Authentication 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/Upv1capturecontextsOrderInformation.md b/docs/Upv1capturecontextsOrderInformation.md new file mode 100644 index 00000000..65de4e5c --- /dev/null +++ b/docs/Upv1capturecontextsOrderInformation.md @@ -0,0 +1,12 @@ +# Upv1capturecontextsOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_details** | [**Upv1capturecontextsOrderInformationAmountDetails**](Upv1capturecontextsOrderInformationAmountDetails.md) | | [optional] +**bill_to** | [**Upv1capturecontextsOrderInformationBillTo**](Upv1capturecontextsOrderInformationBillTo.md) | | [optional] +**ship_to** | [**Upv1capturecontextsOrderInformationShipTo**](Upv1capturecontextsOrderInformationShipTo.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/Upv1capturecontextsOrderInformationAmountDetails.md b/docs/Upv1capturecontextsOrderInformationAmountDetails.md new file mode 100644 index 00000000..8e055022 --- /dev/null +++ b/docs/Upv1capturecontextsOrderInformationAmountDetails.md @@ -0,0 +1,11 @@ +# Upv1capturecontextsOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_amount** | **str** | This field defines the total order amount. | [optional] +**currency** | **str** | This field defines the currency applicable 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/Upv1capturecontextsOrderInformationBillTo.md b/docs/Upv1capturecontextsOrderInformationBillTo.md new file mode 100644 index 00000000..68236824 --- /dev/null +++ b/docs/Upv1capturecontextsOrderInformationBillTo.md @@ -0,0 +1,28 @@ +# Upv1capturecontextsOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] +**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. | [optional] +**address3** | **str** | Additional address information (third line of the billing address) | [optional] +**address4** | **str** | Additional address information (fourth line of the billing address) | [optional] +**administrative_area** | **str** | 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). | [optional] +**building_number** | **str** | Building number in the street address. | [optional] +**country** | **str** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). | [optional] +**district** | **str** | Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality | [optional] +**locality** | **str** | Payment card billing city. | [optional] +**postal_code** | **str** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. | [optional] +**company** | [**Upv1capturecontextsOrderInformationBillToCompany**](Upv1capturecontextsOrderInformationBillToCompany.md) | | [optional] +**email** | **str** | Customer's email address, including the full domain name. | [optional] +**first_name** | **str** | Customer's first name. This name must be the same as the name on the card | [optional] +**last_name** | **str** | Customer's last name. This name must be the same as the name on the card. | [optional] +**middle_name** | **str** | Customer's middle name. | [optional] +**name_suffix** | **str** | Customer's name suffix. | [optional] +**title** | **str** | Title. | [optional] +**phone_number** | **str** | Customer's phone number. | [optional] +**phone_type** | **str** | Customer's phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work | [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/Upv1capturecontextsOrderInformationBillToCompany.md b/docs/Upv1capturecontextsOrderInformationBillToCompany.md new file mode 100644 index 00000000..7fc4fa23 --- /dev/null +++ b/docs/Upv1capturecontextsOrderInformationBillToCompany.md @@ -0,0 +1,20 @@ +# Upv1capturecontextsOrderInformationBillToCompany + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the customer's company. | [optional] +**address1** | **str** | Payment card billing street address as it appears on the credit card issuer's records. | [optional] +**address2** | **str** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. | [optional] +**address3** | **str** | Additional address information (third line of the billing address) | [optional] +**address4** | **str** | Additional address information (fourth line of the billing address) | [optional] +**administrative_area** | **str** | 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). | [optional] +**building_number** | **str** | Building number in the street address. | [optional] +**country** | **str** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). | [optional] +**district** | **str** | Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality | [optional] +**locality** | **str** | Payment card billing city. | [optional] +**postal_code** | **str** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. | [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/Upv1capturecontextsOrderInformationShipTo.md b/docs/Upv1capturecontextsOrderInformationShipTo.md new file mode 100644 index 00000000..c6259ac9 --- /dev/null +++ b/docs/Upv1capturecontextsOrderInformationShipTo.md @@ -0,0 +1,21 @@ +# Upv1capturecontextsOrderInformationShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | First line of the shipping address. | [optional] +**address2** | **str** | Second line of the shipping address. | [optional] +**address3** | **str** | Third line of the shipping address. | [optional] +**address4** | **str** | Fourth line of the shipping address. | [optional] +**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) | [optional] +**building_number** | **str** | Building number in the street address. | [optional] +**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) | [optional] +**district** | **str** | Neighborhood, community, or region within a city or municipality. | [optional] +**locality** | **str** | City of the shipping address. | [optional] +**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. | [optional] +**first_name** | **str** | First name of the recipient | [optional] +**last_name** | **str** | Last name of the recipient. | [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/UserManagementApi.md b/docs/UserManagementApi.md new file mode 100644 index 00000000..71649150 --- /dev/null +++ b/docs/UserManagementApi.md @@ -0,0 +1,63 @@ +# CyberSource.UserManagementApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_users**](UserManagementApi.md#get_users) | **GET** /ums/v1/users | Get User Information - Deprecated + + +# **get_users** +> UmsV1UsersGet200Response get_users(organization_id=organization_id, user_name=user_name, permission_id=permission_id, role_id=role_id) + +Get User Information - Deprecated + +This endpoint is deprecated. Please use the search end point. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.UserManagementApi() +organization_id = 'organization_id_example' # str | This is the orgId of the organization which the user belongs to. (optional) +user_name = 'user_name_example' # str | User ID of the user you want to get details on. (optional) +permission_id = 'permission_id_example' # str | permission that you are trying to search user on. (optional) +role_id = 'role_id_example' # str | role of the user you are trying to search on. (optional) + +try: + # Get User Information - Deprecated + api_response = api_instance.get_users(organization_id=organization_id, user_name=user_name, permission_id=permission_id, role_id=role_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling UserManagementApi->get_users: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | **str**| This is the orgId of the organization which the user belongs to. | [optional] + **user_name** | **str**| User ID of the user you want to get details on. | [optional] + **permission_id** | **str**| permission that you are trying to search user on. | [optional] + **role_id** | **str**| role of the user you are trying to search on. | [optional] + +### Return type + +[**UmsV1UsersGet200Response**](UmsV1UsersGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UserManagementSearchApi.md b/docs/UserManagementSearchApi.md new file mode 100644 index 00000000..073760fb --- /dev/null +++ b/docs/UserManagementSearchApi.md @@ -0,0 +1,57 @@ +# CyberSource.UserManagementSearchApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**search_users**](UserManagementSearchApi.md#search_users) | **POST** /ums/v1/users/search | Search User Information + + +# **search_users** +> UmsV1UsersGet200Response search_users(search_request) + +Search User Information + +This endpoint is to get all the user information depending on the filter criteria passed in request body. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.UserManagementSearchApi() +search_request = CyberSource.SearchRequest() # SearchRequest | + +try: + # Search User Information + api_response = api_instance.search_users(search_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling UserManagementSearchApi->search_users: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_request** | [**SearchRequest**](SearchRequest.md)| | + +### Return type + +[**UmsV1UsersGet200Response**](UmsV1UsersGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/V1FileDetailsGet200Response.md b/docs/V1FileDetailsGet200Response.md new file mode 100644 index 00000000..e5d12a11 --- /dev/null +++ b/docs/V1FileDetailsGet200Response.md @@ -0,0 +1,11 @@ +# V1FileDetailsGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_details** | [**list[V1FileDetailsGet200ResponseFileDetails]**](V1FileDetailsGet200ResponseFileDetails.md) | | [optional] +**links** | [**V1FileDetailsGet200ResponseLinks**](V1FileDetailsGet200ResponseLinks.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/V1FileDetailsGet200ResponseFileDetails.md b/docs/V1FileDetailsGet200ResponseFileDetails.md new file mode 100644 index 00000000..60357ca8 --- /dev/null +++ b/docs/V1FileDetailsGet200ResponseFileDetails.md @@ -0,0 +1,16 @@ +# V1FileDetailsGet200ResponseFileDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_id** | **str** | Unique identifier of a file | [optional] +**name** | **str** | Name of the file | [optional] +**created_time** | **datetime** | Date and time for the file in PST | [optional] +**last_modified_time** | **datetime** | Date and time for the file in PST | [optional] +**_date** | **date** | Date and time for the file in PST | [optional] +**mime_type** | **str** | 'File extension' Valid values: - 'application/xml' - 'text/csv' - 'application/pdf' - 'application/octet-stream' | [optional] +**size** | **float** | Size of the file in bytes | [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/V1FileDetailsGet200ResponseLinks.md b/docs/V1FileDetailsGet200ResponseLinks.md new file mode 100644 index 00000000..7989a1d2 --- /dev/null +++ b/docs/V1FileDetailsGet200ResponseLinks.md @@ -0,0 +1,11 @@ +# V1FileDetailsGet200ResponseLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**V1FileDetailsGet200ResponseLinksSelf**](V1FileDetailsGet200ResponseLinksSelf.md) | | [optional] +**files** | [**list[V1FileDetailsGet200ResponseLinksFiles]**](V1FileDetailsGet200ResponseLinksFiles.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/V1FileDetailsGet200ResponseLinksFiles.md b/docs/V1FileDetailsGet200ResponseLinksFiles.md new file mode 100644 index 00000000..d76d0e50 --- /dev/null +++ b/docs/V1FileDetailsGet200ResponseLinksFiles.md @@ -0,0 +1,12 @@ +# V1FileDetailsGet200ResponseLinksFiles + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_id** | **str** | Unique identifier for each file | [optional] +**href** | **str** | | [optional] +**method** | **str** | | [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/V1FileDetailsGet200ResponseLinksSelf.md b/docs/V1FileDetailsGet200ResponseLinksSelf.md new file mode 100644 index 00000000..71211e8d --- /dev/null +++ b/docs/V1FileDetailsGet200ResponseLinksSelf.md @@ -0,0 +1,11 @@ +# V1FileDetailsGet200ResponseLinksSelf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **str** | | [optional] +**method** | **str** | | [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/VTConfig.md b/docs/VTConfig.md new file mode 100644 index 00000000..3db08350 --- /dev/null +++ b/docs/VTConfig.md @@ -0,0 +1,11 @@ +# VTConfig + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_not_present** | [**VTConfigCardNotPresent**](VTConfigCardNotPresent.md) | | [optional] +**card_present** | [**VTConfigCardNotPresent**](VTConfigCardNotPresent.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/VTConfigCardNotPresent.md b/docs/VTConfigCardNotPresent.md new file mode 100644 index 00000000..5ece1e88 --- /dev/null +++ b/docs/VTConfigCardNotPresent.md @@ -0,0 +1,11 @@ +# VTConfigCardNotPresent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**global_payment_information** | [**VTConfigCardNotPresentGlobalPaymentInformation**](VTConfigCardNotPresentGlobalPaymentInformation.md) | | [optional] +**receipt_information** | [**VTConfigCardNotPresentReceiptInformation**](VTConfigCardNotPresentReceiptInformation.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/VTConfigCardNotPresentGlobalPaymentInformation.md b/docs/VTConfigCardNotPresentGlobalPaymentInformation.md new file mode 100644 index 00000000..75c8d8a9 --- /dev/null +++ b/docs/VTConfigCardNotPresentGlobalPaymentInformation.md @@ -0,0 +1,12 @@ +# VTConfigCardNotPresentGlobalPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**basic_information** | [**VTConfigCardNotPresentGlobalPaymentInformationBasicInformation**](VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md) | | [optional] +**payment_information** | [**VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation**](VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md) | | [optional] +**merchant_defined_data_fields** | [**VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields**](VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.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/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md b/docs/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md new file mode 100644 index 00000000..470db890 --- /dev/null +++ b/docs/VTConfigCardNotPresentGlobalPaymentInformationBasicInformation.md @@ -0,0 +1,18 @@ +# VTConfigCardNotPresentGlobalPaymentInformationBasicInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**default_standard_entry_class_code** | **str** | | [optional] +**default_country_code** | **str** | ISO 4217 format | [optional] +**default_currency_code** | **str** | Three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] +**default_transaction_type** | **str** | Possible values: - AUTHORIZATION - SALE | [optional] +**default_payment_type** | **str** | Possible values: - CREDIT_CARD - ECHECK | [optional] +**default_transaction_source** | **str** | | [optional] +**display_retail** | **bool** | | [optional] +**display_moto** | **bool** | | [optional] +**display_internet** | **bool** | | [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/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.md b/docs/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.md new file mode 100644 index 00000000..44778e0d --- /dev/null +++ b/docs/VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields.md @@ -0,0 +1,34 @@ +# VTConfigCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_merchant_defined_data1** | **bool** | | [optional] +**display_merchant_defined_data2** | **bool** | | [optional] +**display_merchant_defined_data3** | **bool** | | [optional] +**display_merchant_defined_data4** | **bool** | | [optional] +**display_merchant_defined_data5** | **bool** | | [optional] +**merchant_defined_data1_default_value** | **str** | | [optional] +**merchant_defined_data1_label** | **str** | | [optional] +**require_merchant_defined_data1** | **bool** | | [optional] +**merchant_defined_data2_default_value** | **str** | | [optional] +**merchant_defined_data2_label** | **str** | | [optional] +**require_merchant_defined_data2** | **bool** | | [optional] +**merchant_defined_data3_default_value** | **str** | | [optional] +**merchant_defined_data3_label** | **str** | | [optional] +**require_merchant_defined_data3** | **bool** | | [optional] +**merchant_defined_data4_default_value** | **str** | | [optional] +**merchant_defined_data4_label** | **str** | | [optional] +**require_merchant_defined_data4** | **bool** | | [optional] +**merchant_defined_data5_default_value** | **str** | | [optional] +**merchant_defined_data5_label** | **str** | | [optional] +**require_merchant_defined_data5** | **bool** | | [optional] +**merchant_defined_data1_display_on_receipt** | **bool** | | [optional] +**merchant_defined_data2_display_on_receipt** | **bool** | | [optional] +**merchant_defined_data3_display_on_receipt** | **bool** | | [optional] +**merchant_defined_data4_display_on_receipt** | **bool** | | [optional] +**merchant_defined_data5_display_on_receipt** | **bool** | | [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/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md b/docs/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md new file mode 100644 index 00000000..8a3d3294 --- /dev/null +++ b/docs/VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation.md @@ -0,0 +1,22 @@ +# VTConfigCardNotPresentGlobalPaymentInformationPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_card_verification_value** | **list[str]** | | [optional] +**require_card_verification_value** | **list[str]** | | [optional] +**accepted_card_types** | **list[str]** | | [optional] +**display_credit_cards** | **bool** | | [optional] +**display_echecks** | **bool** | | [optional] +**display_debt_indicator** | **bool** | | [optional] +**display_bill_payment** | **bool** | | [optional] +**enable_echecks** | **bool** | | [optional] +**display_ignore_e_check_avs_checkbox** | **bool** | | [optional] +**first_name_required** | **bool** | | [optional] +**last_name_required** | **bool** | | [optional] +**display_first_name** | **bool** | | [optional] +**display_last_name** | **bool** | | [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/VTConfigCardNotPresentReceiptInformation.md b/docs/VTConfigCardNotPresentReceiptInformation.md new file mode 100644 index 00000000..a7a56623 --- /dev/null +++ b/docs/VTConfigCardNotPresentReceiptInformation.md @@ -0,0 +1,12 @@ +# VTConfigCardNotPresentReceiptInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**header** | [**VTConfigCardNotPresentReceiptInformationHeader**](VTConfigCardNotPresentReceiptInformationHeader.md) | | [optional] +**order_information** | [**VTConfigCardNotPresentReceiptInformationOrderInformation**](VTConfigCardNotPresentReceiptInformationOrderInformation.md) | | [optional] +**email_receipt** | [**VTConfigCardNotPresentReceiptInformationEmailReceipt**](VTConfigCardNotPresentReceiptInformationEmailReceipt.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/VTConfigCardNotPresentReceiptInformationEmailReceipt.md b/docs/VTConfigCardNotPresentReceiptInformationEmailReceipt.md new file mode 100644 index 00000000..8518d6c6 --- /dev/null +++ b/docs/VTConfigCardNotPresentReceiptInformationEmailReceipt.md @@ -0,0 +1,10 @@ +# VTConfigCardNotPresentReceiptInformationEmailReceipt + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**senders_email_address** | **str** | | [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/VTConfigCardNotPresentReceiptInformationHeader.md b/docs/VTConfigCardNotPresentReceiptInformationHeader.md new file mode 100644 index 00000000..71a536e1 --- /dev/null +++ b/docs/VTConfigCardNotPresentReceiptInformationHeader.md @@ -0,0 +1,10 @@ +# VTConfigCardNotPresentReceiptInformationHeader + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**virtual_terminal_receipt_header** | **str** | | [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/VTConfigCardNotPresentReceiptInformationOrderInformation.md b/docs/VTConfigCardNotPresentReceiptInformationOrderInformation.md new file mode 100644 index 00000000..d5424e4e --- /dev/null +++ b/docs/VTConfigCardNotPresentReceiptInformationOrderInformation.md @@ -0,0 +1,11 @@ +# VTConfigCardNotPresentReceiptInformationOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email_alias_name** | **str** | | [optional] +**custom_reply_to_email_address** | **str** | | [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/ValidateExportComplianceRequest.md b/docs/ValidateExportComplianceRequest.md new file mode 100644 index 00000000..095dd241 --- /dev/null +++ b/docs/ValidateExportComplianceRequest.md @@ -0,0 +1,14 @@ +# ValidateExportComplianceRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Riskv1liststypeentriesClientReferenceInformation**](Riskv1liststypeentriesClientReferenceInformation.md) | | [optional] +**order_information** | [**Riskv1exportcomplianceinquiriesOrderInformation**](Riskv1exportcomplianceinquiriesOrderInformation.md) | | [optional] +**buyer_information** | [**Riskv1addressverificationsBuyerInformation**](Riskv1addressverificationsBuyerInformation.md) | | [optional] +**device_information** | [**Riskv1exportcomplianceinquiriesDeviceInformation**](Riskv1exportcomplianceinquiriesDeviceInformation.md) | | [optional] +**export_compliance_information** | [**Riskv1exportcomplianceinquiriesExportComplianceInformation**](Riskv1exportcomplianceinquiriesExportComplianceInformation.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/ValidateRequest.md b/docs/ValidateRequest.md new file mode 100644 index 00000000..1ca0eb0a --- /dev/null +++ b/docs/ValidateRequest.md @@ -0,0 +1,16 @@ +# ValidateRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Riskv1authenticationsetupsClientReferenceInformation**](Riskv1authenticationsetupsClientReferenceInformation.md) | | [optional] +**processing_information** | [**Riskv1authenticationsetupsProcessingInformation**](Riskv1authenticationsetupsProcessingInformation.md) | | [optional] +**order_information** | [**Riskv1authenticationresultsOrderInformation**](Riskv1authenticationresultsOrderInformation.md) | | [optional] +**payment_information** | [**Riskv1authenticationresultsPaymentInformation**](Riskv1authenticationresultsPaymentInformation.md) | | [optional] +**consumer_authentication_information** | [**Riskv1authenticationresultsConsumerAuthenticationInformation**](Riskv1authenticationresultsConsumerAuthenticationInformation.md) | | [optional] +**device_information** | [**Riskv1authenticationresultsDeviceInformation**](Riskv1authenticationresultsDeviceInformation.md) | | [optional] +**token_information** | [**Riskv1decisionsTokenInformation**](Riskv1decisionsTokenInformation.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/ValueAddedServicesProducts.md b/docs/ValueAddedServicesProducts.md new file mode 100644 index 00000000..58619077 --- /dev/null +++ b/docs/ValueAddedServicesProducts.md @@ -0,0 +1,12 @@ +# ValueAddedServicesProducts + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reporting** | [**PaymentsProductsTax**](PaymentsProductsTax.md) | | [optional] +**transaction_search** | [**PaymentsProductsTax**](PaymentsProductsTax.md) | | [optional] +**bank_account_validation** | [**PaymentsProductsTax**](PaymentsProductsTax.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/VasV2PaymentsPost201Response.md b/docs/VasV2PaymentsPost201Response.md new file mode 100644 index 00000000..07ce5b35 --- /dev/null +++ b/docs/VasV2PaymentsPost201Response.md @@ -0,0 +1,16 @@ +# VasV2PaymentsPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**VasV2PaymentsPost201ResponseLinks**](VasV2PaymentsPost201ResponseLinks.md) | | [optional] +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - COMPLETED | [optional] +**client_reference_information** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional] +**tax_information** | [**VasV2PaymentsPost201ResponseTaxInformation**](VasV2PaymentsPost201ResponseTaxInformation.md) | | [optional] +**order_information** | [**VasV2PaymentsPost201ResponseOrderInformation**](VasV2PaymentsPost201ResponseOrderInformation.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/VasV2PaymentsPost201ResponseLinks.md b/docs/VasV2PaymentsPost201ResponseLinks.md new file mode 100644 index 00000000..ed434132 --- /dev/null +++ b/docs/VasV2PaymentsPost201ResponseLinks.md @@ -0,0 +1,10 @@ +# VasV2PaymentsPost201ResponseLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**void** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.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/VasV2PaymentsPost201ResponseOrderInformation.md b/docs/VasV2PaymentsPost201ResponseOrderInformation.md new file mode 100644 index 00000000..262635f8 --- /dev/null +++ b/docs/VasV2PaymentsPost201ResponseOrderInformation.md @@ -0,0 +1,15 @@ +# VasV2PaymentsPost201ResponseOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exempt_amount** | **str** | Total amount of tax exempt amounts. This value is the sum of the values for all the `orderInformation.lineItems[].exemptAmount` fields in the tax calculation request. | [optional] +**taxable_amount** | **str** | Total amount of all taxable amounts. This value is the sum of the values for all the `orderInformation.lineItems[].taxAmount` fields in the tax calculation request. | [optional] +**tax_amount** | **str** | Total amount of tax for all lineItems in the tax calculation request. | [optional] +**line_items** | [**list[VasV2PaymentsPost201ResponseOrderInformationLineItems]**](VasV2PaymentsPost201ResponseOrderInformationLineItems.md) | | [optional] +**tax_details** | [**list[VasV2PaymentsPost201ResponseOrderInformationTaxDetails]**](VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md) | | [optional] +**amount_details** | [**Ptsv2paymentsidreversalsReversalInformationAmountDetails**](Ptsv2paymentsidreversalsReversalInformationAmountDetails.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/VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md b/docs/VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md new file mode 100644 index 00000000..e585d971 --- /dev/null +++ b/docs/VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md @@ -0,0 +1,18 @@ +# VasV2PaymentsPost201ResponseOrderInformationJurisdiction + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Type of tax jurisdiction for the item. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. Possible values: - `city` - `county` - `state` - `country` - `special` | [optional] +**tax_name** | **str** | Name of the jurisdiction tax for the item. For example, CA State Tax. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] +**tax_amount** | **str** | Jurisdiction tax amount for the item. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] +**taxable** | **str** | Jurisdiction taxable amount for the item, not including product level exemptions. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] +**name** | **str** | Free-text description of the jurisdiction for the item. For example, San Mateo County. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] +**code** | **str** | Jurisdiction code assigned by the tax provider. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] +**rate** | **str** | Jurisdiction tax rate for the item. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] +**region** | **str** | Free-text description of the jurisdiction region for the item. For example, CA (California State) or GB (Great Britain). Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] +**country** | **str** | Tax jurisdiction country for the item. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [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/VasV2PaymentsPost201ResponseOrderInformationLineItems.md b/docs/VasV2PaymentsPost201ResponseOrderInformationLineItems.md new file mode 100644 index 00000000..c419e8af --- /dev/null +++ b/docs/VasV2PaymentsPost201ResponseOrderInformationLineItems.md @@ -0,0 +1,14 @@ +# VasV2PaymentsPost201ResponseOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tax_details** | [**list[VasV2PaymentsPost201ResponseOrderInformationTaxDetails]**](VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md) | | [optional] +**jurisdiction** | [**list[VasV2PaymentsPost201ResponseOrderInformationJurisdiction]**](VasV2PaymentsPost201ResponseOrderInformationJurisdiction.md) | | [optional] +**exempt_amount** | **str** | Exempt amount for the lineItem. Returned only if the `taxInformation.showTaxPerLineItem` field is set to `Yes`. | [optional] +**taxable_amount** | **str** | Portion of the item amount that is taxable. | [optional] +**tax_amount** | **str** | Total tax for the item. This value is the sum of all taxes applied to the item. | [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/VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md b/docs/VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md new file mode 100644 index 00000000..5e285a13 --- /dev/null +++ b/docs/VasV2PaymentsPost201ResponseOrderInformationTaxDetails.md @@ -0,0 +1,11 @@ +# VasV2PaymentsPost201ResponseOrderInformationTaxDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Allowed tax types: - city - county - state - national - special | [optional] +**amount** | **str** | Amount corresponding to different types of taxes applied. | [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/VasV2PaymentsPost201ResponseTaxInformation.md b/docs/VasV2PaymentsPost201ResponseTaxInformation.md new file mode 100644 index 00000000..d70b28f8 --- /dev/null +++ b/docs/VasV2PaymentsPost201ResponseTaxInformation.md @@ -0,0 +1,11 @@ +# VasV2PaymentsPost201ResponseTaxInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commit_indicator** | **bool** | Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is \"Committed.\" For an uncommitted tax transaction, the status in the Tax Detail Report is \"Uncommitted.\" Possible values: - `true`: This is a committed tax transaction. - `false` (default): This is not a committed tax transaction. A committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed. The committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit. Use a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). | [optional] +**refund_indicator** | **bool** | Indicates whether this is a refund tax transaction. For a refund tax transaction, amounts in the Tax Detail Report will be negative. Possible values: - `true`: This is a refund tax transaction. - `false` (default): This is not a refund tax transaction. A refund tax request is a tax service request that sets the transaction type field in the Tax Detail Report to refunded and makes the reported amount negative. Tax amounts are returned as positive amounts in reply messages, but they are saved in reports as negative amounts which enables the reporting software to accurately calculate the aggregate amounts. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). | [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/VasV2PaymentsPost400Response.md b/docs/VasV2PaymentsPost400Response.md new file mode 100644 index 00000000..95ba7ab2 --- /dev/null +++ b/docs/VasV2PaymentsPost400Response.md @@ -0,0 +1,14 @@ +# VasV2PaymentsPost400Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] +**reason** | **str** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - INVALID_MERCHANT_CONFIGURATION - INVALID_ADDRESS | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/VasV2TaxVoid200Response.md b/docs/VasV2TaxVoid200Response.md new file mode 100644 index 00000000..7eeda555 --- /dev/null +++ b/docs/VasV2TaxVoid200Response.md @@ -0,0 +1,14 @@ +# VasV2TaxVoid200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - VOIDED - CANCELLED - FAILED | [optional] +**client_reference_information** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional] +**void_amount_details** | [**VasV2TaxVoid200ResponseVoidAmountDetails**](VasV2TaxVoid200ResponseVoidAmountDetails.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/VasV2TaxVoid200ResponseVoidAmountDetails.md b/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md new file mode 100644 index 00000000..44790f2f --- /dev/null +++ b/docs/VasV2TaxVoid200ResponseVoidAmountDetails.md @@ -0,0 +1,11 @@ +# VasV2TaxVoid200ResponseVoidAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**void_amount** | **str** | Total amount of the void. #### PIN Debit Amount of the reversal. Returned by PIN debit reversal. | [optional] +**currency** | **str** | 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/VasV2TaxVoidsPost400Response.md b/docs/VasV2TaxVoidsPost400Response.md new file mode 100644 index 00000000..02dc9424 --- /dev/null +++ b/docs/VasV2TaxVoidsPost400Response.md @@ -0,0 +1,14 @@ +# VasV2TaxVoidsPost400Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] +**reason** | **str** | The reason of the status. Possible values: - INVALID_DATA - NOT_VOIDABLE | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.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/Vasv2taxBuyerInformation.md b/docs/Vasv2taxBuyerInformation.md new file mode 100644 index 00000000..209b1e2b --- /dev/null +++ b/docs/Vasv2taxBuyerInformation.md @@ -0,0 +1,10 @@ +# Vasv2taxBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**vat_registration_number** | **str** | 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/Vasv2taxClientReferenceInformation.md b/docs/Vasv2taxClientReferenceInformation.md new file mode 100644 index 00000000..a5bc2d50 --- /dev/null +++ b/docs/Vasv2taxClientReferenceInformation.md @@ -0,0 +1,12 @@ +# Vasv2taxClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | 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** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] +**comments** | **str** | 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/Vasv2taxMerchantInformation.md b/docs/Vasv2taxMerchantInformation.md new file mode 100644 index 00000000..20fd7b26 --- /dev/null +++ b/docs/Vasv2taxMerchantInformation.md @@ -0,0 +1,10 @@ +# Vasv2taxMerchantInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. | [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/Vasv2taxOrderInformation.md b/docs/Vasv2taxOrderInformation.md new file mode 100644 index 00000000..44f7c656 --- /dev/null +++ b/docs/Vasv2taxOrderInformation.md @@ -0,0 +1,17 @@ +# Vasv2taxOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount_details** | [**RiskV1DecisionsPost201ResponseOrderInformationAmountDetails**](RiskV1DecisionsPost201ResponseOrderInformationAmountDetails.md) | | [optional] +**bill_to** | [**Vasv2taxOrderInformationBillTo**](Vasv2taxOrderInformationBillTo.md) | | [optional] +**shipping_details** | [**Vasv2taxOrderInformationShippingDetails**](Vasv2taxOrderInformationShippingDetails.md) | | [optional] +**ship_to** | [**Vasv2taxOrderInformationShipTo**](Vasv2taxOrderInformationShipTo.md) | | [optional] +**line_items** | [**list[Vasv2taxOrderInformationLineItems]**](Vasv2taxOrderInformationLineItems.md) | | [optional] +**invoice_details** | [**Vasv2taxOrderInformationInvoiceDetails**](Vasv2taxOrderInformationInvoiceDetails.md) | | [optional] +**order_acceptance** | [**Vasv2taxOrderInformationOrderAcceptance**](Vasv2taxOrderInformationOrderAcceptance.md) | | [optional] +**order_origin** | [**Vasv2taxOrderInformationOrderOrigin**](Vasv2taxOrderInformationOrderOrigin.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/Vasv2taxOrderInformationBillTo.md b/docs/Vasv2taxOrderInformationBillTo.md new file mode 100644 index 00000000..83432cb4 --- /dev/null +++ b/docs/Vasv2taxOrderInformationBillTo.md @@ -0,0 +1,15 @@ +# Vasv2taxOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **str** | First line of the billing street address. #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**address2** | **str** | Second line of the billing street address. #### Tax Calculation Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**locality** | **str** | Credit card billing city. #### Tax Calculation Required for U.S. and Canadian taxes only. Not applicable to international and value added taxes. | [optional] +**administrative_area** | **str** | Credit card billing state or province. #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**postal_code** | **str** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. If the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example**: 12345-6789 If the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha] [numeric][alpha][numeric] **Example**: A1B 2C3 #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**country** | **str** | Credit card billing country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). If `orderInformation.shipTo.country` is not provided, `orderInformation.billTo.country` is used in its place. If `orderInformation.billTo.country` is set to `US` or `CA`, then `orderInformation.billTo.postalCode` and `orderInformation.billTo.administrativeArea` are also required. #### Tax Calculation Required for U.S., Canadian, international and value added 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/Vasv2taxOrderInformationInvoiceDetails.md b/docs/Vasv2taxOrderInformationInvoiceDetails.md new file mode 100644 index 00000000..afdc6338 --- /dev/null +++ b/docs/Vasv2taxOrderInformationInvoiceDetails.md @@ -0,0 +1,10 @@ +# Vasv2taxOrderInformationInvoiceDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**invoice_date** | **str** | Date of the tax calculation. Use format YYYYMMDD. You can provide a date in the past if you are calculating tax for a refund and want to know what the tax was on the date the order was placed. You can provide a date in the future if you are calculating the tax for a future date, such as an upcoming tax holiday. The default is the date, in Pacific time, that the bank receives the request. Keep this in mind if you are in a different time zone and want the tax calculated with the rates that are applicable on a specific date. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added 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/Vasv2taxOrderInformationLineItems.md b/docs/Vasv2taxOrderInformationLineItems.md new file mode 100644 index 00000000..3dae99de --- /dev/null +++ b/docs/Vasv2taxOrderInformationLineItems.md @@ -0,0 +1,23 @@ +# Vasv2taxOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] +**order_acceptance** | [**Vasv2taxOrderInformationOrderAcceptance**](Vasv2taxOrderInformationOrderAcceptance.md) | | [optional] +**order_origin** | [**Vasv2taxOrderInformationOrderOrigin**](Vasv2taxOrderInformationOrderOrigin.md) | | [optional] +**ship_from_country** | **str** | Country from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromAdministrativeArea` are present. Use the [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/ or rates applied to the transaction based on sourcing. Optional for U.S., Canadian, international tax, and value added taxes. | [optional] +**ship_from_administrative_area** | **str** | State from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromCountry` are present. Use the [State, Province, and Territory Codes for the United States and Canada](http://apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**ship_from_locality** | **str** | City where the product is shipped from. This field is used only when the `orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**ship_from_postal_code** | **str** | Postal code where the product is shipped from. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**buyer_vat_registration_number** | **str** | Buyer's VAT registration number. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] +**seller_vat_registration_number** | **str** | VAT seller registration number. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field 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/Vasv2taxOrderInformationOrderAcceptance.md b/docs/Vasv2taxOrderInformationOrderAcceptance.md new file mode 100644 index 00000000..9fe9b05c --- /dev/null +++ b/docs/Vasv2taxOrderInformationOrderAcceptance.md @@ -0,0 +1,13 @@ +# Vasv2taxOrderInformationOrderAcceptance + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locality** | **str** | Order acceptance city. This field is not used unless the `orderInformation.orderAcceptance.administrativeArea` and `orderInformation.orderAcceptance.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**administrative_area** | **str** | Order acceptance state. This field is not used unless the `orderInformation.orderAcceptance.locality` and `orderInformation.orderAcceptance.country` fields are present. 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). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**postal_code** | **str** | Order acceptance postal code. This field is not used unless the `orderInformation.orderAcceptance.locality`, `orderInformation.orderAcceptance.administrativeArea`, and `orderInformation.orderAcceptance.country` fields are present. Must be sent at the line or offer level to be surfaced in the Tax Detail Report. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**country** | **str** | Order acceptance country. This field is not used unless the `orderInformation.orderAcceptance.administrativeArea` and `orderInformation.orderAcceptance.locality` fields are present. Use the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added 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/Vasv2taxOrderInformationOrderOrigin.md b/docs/Vasv2taxOrderInformationOrderOrigin.md new file mode 100644 index 00000000..8eaba87f --- /dev/null +++ b/docs/Vasv2taxOrderInformationOrderOrigin.md @@ -0,0 +1,13 @@ +# Vasv2taxOrderInformationOrderOrigin + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locality** | **str** | Order origin city. This field is not used unless the `orderInformation.orderOrigin.administrativeArea` and `orderInformation.orderOrigin.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**administrative_area** | **str** | Order origin state. This field is not used unless the `orderInformation.orderOrigin.locality` and `orderInformation.orderOrigin.country` fields are present. Use the [State, Province, and Territory Codes for the United States and Canada](http://apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**postal_code** | **str** | Order origin postal code. This field is not used unless the `orderInformation.orderOrigin.locality`, `orderInformation.orderOrigin.administrativeArea` and `orderInformation.orderOrigin.country` fields are present. Must be sent at the lineItem level to appear in the Tax Detail Report. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**country** | **str** | Order origin country. This field is not used unless the `orderInformation.orderOrigin.administrativeArea` and `orderInformation.orderOrigin.locality` fields are present. Use the [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added 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/Vasv2taxOrderInformationShipTo.md b/docs/Vasv2taxOrderInformationShipTo.md new file mode 100644 index 00000000..af13174f --- /dev/null +++ b/docs/Vasv2taxOrderInformationShipTo.md @@ -0,0 +1,16 @@ +# Vasv2taxOrderInformationShipTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**administrative_area** | **str** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] +**address3** | **str** | Third line of the shipping address. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [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/Vasv2taxOrderInformationShippingDetails.md b/docs/Vasv2taxOrderInformationShippingDetails.md new file mode 100644 index 00000000..07eae06c --- /dev/null +++ b/docs/Vasv2taxOrderInformationShippingDetails.md @@ -0,0 +1,13 @@ +# Vasv2taxOrderInformationShippingDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ship_from_locality** | **str** | City where the product is shipped from. This field is used only when the `orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**ship_from_country** | **str** | Country from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromAdministrativeArea` are present. Use the [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/ or rates applied to the transaction based on sourcing. Optional for U.S., Canadian, international tax, and value added taxes. | [optional] +**ship_from_postal_code** | **str** | Postal code where the product is shipped from. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] +**ship_from_administrative_area** | **str** | State from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromCountry` are present. Use the [State, Province, and Territory Codes for the United States and Canada](http://apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added 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/Vasv2taxTaxInformation.md b/docs/Vasv2taxTaxInformation.md new file mode 100644 index 00000000..64855d1a --- /dev/null +++ b/docs/Vasv2taxTaxInformation.md @@ -0,0 +1,16 @@ +# Vasv2taxTaxInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reporting_date** | **str** | Reporting date of transaction. Format: YYYYMMDD. Defaults to current date if not specified. Optional for U.S., Canadian, international tax, and value added taxes. | [optional] +**date_override_reason** | **str** | If a past or future date is specified in `orderInformation.invoiceDetails.invoiceDate`, then provide the reason for that for audit purposes. Typical reasons include: 'Return', 'Layaway', 'Imported'. Optional for U.S., Canadian, international tax, and value added taxes. | [optional] +**nexus** | **list[str]** | Comma-separated list of states or provinces in which merchandise is taxable. Note merchandise may be still be non-taxable or tax exempt depending on the product taxability. Indicate the type of product you are selling in the product code field for product-level taxability rules to be applied. Do not use both the `taxInformation.nexus` and `taxInformation.noNexus` fields in your request. If you do not include this field in a tax calculation service request, the tax system makes its calculations as if you have nexus in every US state or Canadian province. 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). If you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report. Optional field for U.S. and Canadian taxes only. Either this field or `taxInformation.noNexus` is required if you do not have nexus in every state or province. Not applicable for international and value added taxes. | [optional] +**no_nexus** | **list[str]** | Comma-separated list of states or provinces where you do not have nexus. Check with a tax advisor to determine where your business has nexus. Do not use both the `taxInformation.nexus` and `taxInformation.noNexus` fields in your request. If you do not include this field in a tax calculation service request, the tax system makes its calculations as if you have nexus in every US state or Canadian province. 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). If you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report. Optional field for U.S. and Canadian taxes only. Either this field or `taxInformation.nexus` is required if you do not have nexus in every state or province. Not applicable for international and value added taxes. | [optional] +**show_tax_per_line_item** | **str** | Whether or not to display tax amounts for each line item. This field can contain one of the following values: - `Yes` - Display tax amounts for each line item - `No` (default) - Do not display tax amounts for each line item Optional for U.S., Canadian, international tax, and value added taxes. | [optional] +**commit_indicator** | **bool** | Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is \"Committed.\" For an uncommitted tax transaction, the status in the Tax Detail Report is \"Uncommitted.\" Possible values: - `true`: This is a committed tax transaction. - `false` (default): This is not a committed tax transaction. A committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed. The committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit. Use a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). | [optional] +**refund_indicator** | **bool** | Indicates whether this is a refund tax transaction. For a refund tax transaction, amounts in the Tax Detail Report will be negative. Possible values: - `true`: This is a refund tax transaction. - `false` (default): This is not a refund tax transaction. A refund tax request is a tax service request that sets the transaction type field in the Tax Detail Report to refunded and makes the reported amount negative. Tax amounts are returned as positive amounts in reply messages, but they are saved in reports as negative amounts which enables the reporting software to accurately calculate the aggregate amounts. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). | [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/Vasv2taxidClientReferenceInformation.md b/docs/Vasv2taxidClientReferenceInformation.md new file mode 100644 index 00000000..694d1365 --- /dev/null +++ b/docs/Vasv2taxidClientReferenceInformation.md @@ -0,0 +1,12 @@ +# Vasv2taxidClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | 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** | **str** | Brief description of the order or any comment you wish to add to the order. | [optional] +**partner** | [**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/docs/Vasv2taxidClientReferenceInformationPartner.md b/docs/Vasv2taxidClientReferenceInformationPartner.md new file mode 100644 index 00000000..2cdc9cc8 --- /dev/null +++ b/docs/Vasv2taxidClientReferenceInformationPartner.md @@ -0,0 +1,11 @@ +# Vasv2taxidClientReferenceInformationPartner + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**solution_id** | **str** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [optional] +**developer_id** | **str** | Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. | [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/VerificationApi.md b/docs/VerificationApi.md new file mode 100644 index 00000000..64bbbbd9 --- /dev/null +++ b/docs/VerificationApi.md @@ -0,0 +1,106 @@ +# CyberSource.VerificationApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**validate_export_compliance**](VerificationApi.md#validate_export_compliance) | **POST** /risk/v1/export-compliance-inquiries | Validate export compliance +[**verify_customer_address**](VerificationApi.md#verify_customer_address) | **POST** /risk/v1/address-verifications | Verify customer address + + +# **validate_export_compliance** +> RiskV1ExportComplianceInquiriesPost201Response validate_export_compliance(validate_export_compliance_request) + +Validate export compliance + +This call checks customer data against specified watch lists to ensure export compliance. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.VerificationApi() +validate_export_compliance_request = CyberSource.ValidateExportComplianceRequest() # ValidateExportComplianceRequest | + +try: + # Validate export compliance + api_response = api_instance.validate_export_compliance(validate_export_compliance_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling VerificationApi->validate_export_compliance: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **validate_export_compliance_request** | [**ValidateExportComplianceRequest**](ValidateExportComplianceRequest.md)| | + +### Return type + +[**RiskV1ExportComplianceInquiriesPost201Response**](RiskV1ExportComplianceInquiriesPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **verify_customer_address** +> RiskV1AddressVerificationsPost201Response verify_customer_address(verify_customer_address_request) + +Verify customer address + +This call verifies that the customer address submitted is valid. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.VerificationApi() +verify_customer_address_request = CyberSource.VerifyCustomerAddressRequest() # VerifyCustomerAddressRequest | + +try: + # Verify customer address + api_response = api_instance.verify_customer_address(verify_customer_address_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling VerificationApi->verify_customer_address: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **verify_customer_address_request** | [**VerifyCustomerAddressRequest**](VerifyCustomerAddressRequest.md)| | + +### Return type + +[**RiskV1AddressVerificationsPost201Response**](RiskV1AddressVerificationsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/VerifyCustomerAddressRequest.md b/docs/VerifyCustomerAddressRequest.md new file mode 100644 index 00000000..1e02669e --- /dev/null +++ b/docs/VerifyCustomerAddressRequest.md @@ -0,0 +1,12 @@ +# VerifyCustomerAddressRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Riskv1liststypeentriesClientReferenceInformation**](Riskv1liststypeentriesClientReferenceInformation.md) | | [optional] +**order_information** | [**Riskv1addressverificationsOrderInformation**](Riskv1addressverificationsOrderInformation.md) | | [optional] +**buyer_information** | [**Riskv1addressverificationsBuyerInformation**](Riskv1addressverificationsBuyerInformation.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/VoidApi.md b/docs/VoidApi.md new file mode 100644 index 00000000..4be78186 --- /dev/null +++ b/docs/VoidApi.md @@ -0,0 +1,261 @@ +# CyberSource.VoidApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**mit_void**](VoidApi.md#mit_void) | **POST** /pts/v2/voids | Timeout Void +[**void_capture**](VoidApi.md#void_capture) | **POST** /pts/v2/captures/{id}/voids | Void a Capture +[**void_credit**](VoidApi.md#void_credit) | **POST** /pts/v2/credits/{id}/voids | Void a Credit +[**void_payment**](VoidApi.md#void_payment) | **POST** /pts/v2/payments/{id}/voids | Void a Payment +[**void_refund**](VoidApi.md#void_refund) | **POST** /pts/v2/refunds/{id}/voids | Void a Refund + + +# **mit_void** +> PtsV2PaymentsVoidsPost201Response mit_void(mit_void_request) + +Timeout Void + +This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in your payment, capture, refund, or credit API call and use same transactionId in this API request payload to reverse the payment. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.VoidApi() +mit_void_request = CyberSource.MitVoidRequest() # MitVoidRequest | + +try: + # Timeout Void + api_response = api_instance.mit_void(mit_void_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling VoidApi->mit_void: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mit_void_request** | [**MitVoidRequest**](MitVoidRequest.md)| | + +### Return type + +[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **void_capture** +> PtsV2PaymentsVoidsPost201Response void_capture(void_capture_request, id) + +Void a Capture + +Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. Include the capture ID in the POST request to cancel the capture. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.VoidApi() +void_capture_request = CyberSource.VoidCaptureRequest() # VoidCaptureRequest | +id = 'id_example' # str | The capture ID returned from a previous capture request. + +try: + # Void a Capture + api_response = api_instance.void_capture(void_capture_request, id) + pprint(api_response) +except ApiException as e: + print("Exception when calling VoidApi->void_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **void_capture_request** | [**VoidCaptureRequest**](VoidCaptureRequest.md)| | + **id** | **str**| The capture ID returned from a previous capture request. | + +### Return type + +[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **void_credit** +> PtsV2PaymentsVoidsPost201Response void_credit(void_credit_request, id) + +Void a Credit + +Include the credit ID in the POST request to cancel the credit. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.VoidApi() +void_credit_request = CyberSource.VoidCreditRequest() # VoidCreditRequest | +id = 'id_example' # str | The credit ID returned from a previous credit request. + +try: + # Void a Credit + api_response = api_instance.void_credit(void_credit_request, id) + pprint(api_response) +except ApiException as e: + print("Exception when calling VoidApi->void_credit: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **void_credit_request** | [**VoidCreditRequest**](VoidCreditRequest.md)| | + **id** | **str**| The credit ID returned from a previous credit request. | + +### Return type + +[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **void_payment** +> PtsV2PaymentsVoidsPost201Response void_payment(void_payment_request, id) + +Void a Payment + +Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to cancel the payment. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.VoidApi() +void_payment_request = CyberSource.VoidPaymentRequest() # VoidPaymentRequest | +id = 'id_example' # str | The payment ID returned from a previous payment request. + +try: + # Void a Payment + api_response = api_instance.void_payment(void_payment_request, id) + pprint(api_response) +except ApiException as e: + print("Exception when calling VoidApi->void_payment: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **void_payment_request** | [**VoidPaymentRequest**](VoidPaymentRequest.md)| | + **id** | **str**| The payment ID returned from a previous payment request. | + +### Return type + +[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **void_refund** +> PtsV2PaymentsVoidsPost201Response void_refund(void_refund_request, id) + +Void a Refund + +Include the refund ID in the POST request to cancel the refund. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.VoidApi() +void_refund_request = CyberSource.VoidRefundRequest() # VoidRefundRequest | +id = 'id_example' # str | The refund ID returned from a previous refund request. + +try: + # Void a Refund + api_response = api_instance.void_refund(void_refund_request, id) + pprint(api_response) +except ApiException as e: + print("Exception when calling VoidApi->void_refund: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **void_refund_request** | [**VoidRefundRequest**](VoidRefundRequest.md)| | + **id** | **str**| The refund ID returned from a previous refund request. | + +### Return type + +[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/VoidCaptureRequest.md b/docs/VoidCaptureRequest.md new file mode 100644 index 00000000..26e97f74 --- /dev/null +++ b/docs/VoidCaptureRequest.md @@ -0,0 +1,15 @@ +# VoidCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional] +**payment_information** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional] +**order_information** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional] +**agreement_information** | [**Ptsv2paymentsidvoidsAgreementInformation**](Ptsv2paymentsidvoidsAgreementInformation.md) | | [optional] +**merchant_information** | [**Ptsv2paymentsidvoidsMerchantInformation**](Ptsv2paymentsidvoidsMerchantInformation.md) | | [optional] +**processing_information** | [**Ptsv2paymentsidvoidsProcessingInformation**](Ptsv2paymentsidvoidsProcessingInformation.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/VoidCreditRequest.md b/docs/VoidCreditRequest.md new file mode 100644 index 00000000..dce2ba48 --- /dev/null +++ b/docs/VoidCreditRequest.md @@ -0,0 +1,15 @@ +# VoidCreditRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional] +**payment_information** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional] +**order_information** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional] +**agreement_information** | [**Ptsv2paymentsidvoidsAgreementInformation**](Ptsv2paymentsidvoidsAgreementInformation.md) | | [optional] +**merchant_information** | [**Ptsv2paymentsidvoidsMerchantInformation**](Ptsv2paymentsidvoidsMerchantInformation.md) | | [optional] +**processing_information** | [**Ptsv2paymentsidvoidsProcessingInformation**](Ptsv2paymentsidvoidsProcessingInformation.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/VoidPaymentRequest.md b/docs/VoidPaymentRequest.md new file mode 100644 index 00000000..ef3867db --- /dev/null +++ b/docs/VoidPaymentRequest.md @@ -0,0 +1,15 @@ +# VoidPaymentRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional] +**payment_information** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional] +**order_information** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional] +**agreement_information** | [**Ptsv2paymentsidvoidsAgreementInformation**](Ptsv2paymentsidvoidsAgreementInformation.md) | | [optional] +**merchant_information** | [**Ptsv2paymentsidvoidsMerchantInformation**](Ptsv2paymentsidvoidsMerchantInformation.md) | | [optional] +**processing_information** | [**Ptsv2paymentsidvoidsProcessingInformation**](Ptsv2paymentsidvoidsProcessingInformation.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/VoidRefundRequest.md b/docs/VoidRefundRequest.md new file mode 100644 index 00000000..1c15f29f --- /dev/null +++ b/docs/VoidRefundRequest.md @@ -0,0 +1,15 @@ +# VoidRefundRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional] +**payment_information** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional] +**order_information** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional] +**agreement_information** | [**Ptsv2paymentsidvoidsAgreementInformation**](Ptsv2paymentsidvoidsAgreementInformation.md) | | [optional] +**merchant_information** | [**Ptsv2paymentsidvoidsMerchantInformation**](Ptsv2paymentsidvoidsMerchantInformation.md) | | [optional] +**processing_information** | [**Ptsv2paymentsidvoidsProcessingInformation**](Ptsv2paymentsidvoidsProcessingInformation.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/VoidTaxRequest.md b/docs/VoidTaxRequest.md new file mode 100644 index 00000000..0de6a14a --- /dev/null +++ b/docs/VoidTaxRequest.md @@ -0,0 +1,10 @@ +# VoidTaxRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Vasv2taxidClientReferenceInformation**](Vasv2taxidClientReferenceInformation.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) + +