@paciolan/cybersource-sdk

/** * CyberSource Merged Spec * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ import { CardProcessingConfigCommonAcquirer } from './card-processing-config-common-acquirer'; import { CardProcessingConfigCommonCurrencies1 } from './card-processing-config-common-currencies1'; import { CardProcessingConfigCommonPaymentTypes } from './card-processing-config-common-payment-types'; /** * * @export * @interface CardProcessingConfigCommonProcessors */ export interface CardProcessingConfigCommonProcessors { /** * Determines the batching group that separates merchants for special batching times. Batching groups can separate merchant batches by the following criteria: * Timezone * Merchant deadlines * Large merchants (top 10) * Merchants with Service-Level Agreements Applicable for Chase Paymentech Salem (chasepaymentechsalem), Streamline (streamline2), Six (six), Barclays (barclays2), Paymentech Tampa (paymentechtampa), CMCIC (cmcic), FDC Nashville (smartfdc), RUPAY, American Express Direct (amexdirect), GPN (gpn), VPC, GPX (gpx), CB2A, Barclays HISO (barclayshiso), TSYS (tsys) and FDI Global (fdiglobal) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th></tr></thead> <tr><td>Barclays</td><td>cnp, cp, hybrid</td><td>Yes</td></tr> <tr><td>Barclays HISO</td><td>cnp, cp, hybrid</td><td>Yes</td></tr> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommonProcessors */ batchGroup?: string; /** * Indicates the type of money transfer used in the transaction. Applicable for VPC and GPX (gpx) processors. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ businessApplicationId?: string; /** * Identify merchants that participate in Select Merchant Fee (SMF) programs. Unique to the merchant. Applicable for GPX (gpx) and VPC processors. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ merchantVerificationValue?: string; /** * Routing Number to identify banks within the United States. Applicable for GPX (gpx) processors. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ abaNumber?: string; /** * * @type {CardProcessingConfigCommonAcquirer} * @memberof CardProcessingConfigCommonProcessors */ acquirer?: CardProcessingConfigCommonAcquirer; /** * Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>Barclays HISO</td><td>cp, cnp, hybrid</td><td>Yes</td><td>1</td><td>15</td><td>^[0-9a-zA-Z]+$</td></tr> <tr><td>Barclays</td><td>cp, cnp, hybrid</td><td>Yes</td><td>1</td><td>11</td><td>^[0-9a-zA-Z]+$</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommonProcessors */ merchantId: string; /** * The 'Terminal Id' aka TID, is an identifier used for with your payments processor. Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>Barclays HISO</td><td>cnp, hybrid</td><td>Yes</td><td>1</td><td>16</td><td>^[0-9a-zA-Z]+$</td></tr> <tr><td>Barclays HISO</td><td>cp</td><td>No</td><td>1</td><td>16</td><td>^[0-9a-zA-Z]+$</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommonProcessors */ terminalId?: string; /** * Valid values are: * VISA * MASTERCARD * AMERICAN_EXPRESS * CUP * EFTPOS * DINERS_CLUB * DISCOVER * JCB * @type {{ [key: string]: CardProcessingConfigCommonPaymentTypes; }} * @memberof CardProcessingConfigCommonProcessors */ paymentTypes?: { [key: string]: CardProcessingConfigCommonPaymentTypes; }; /** * Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) * @type {{ [key: string]: CardProcessingConfigCommonCurrencies1; }} * @memberof CardProcessingConfigCommonProcessors */ currencies?: { [key: string]: CardProcessingConfigCommonCurrencies1; }; /** * The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities. Standard Industrial Classification codes were mostly replaced by the six-digit North American Industry Classification System (NAICS). Applicable for VPC and GPX (gpx) processors. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ sicCode?: string; /** * Allows multiple captures for a single authorization transaction. Applicable for Paymentech Tampa (paymentechtampa), VPC, American Express Direct (amexdirect) and GPX (gpx) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, hybrid</td><td>Yes</td><td>No</td></tr> <tr><td>American Express Direct</td><td>cnp</td><td>No</td><td>No</td></tr> </table> * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ allowMultipleBills?: boolean; /** * Enables partner to enable/disable merchant descriptors values. Applicable for VPC, EFTPOS and CUP processors. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ allowMerchantDescriptorOverride?: boolean; /** * To enable airline transactions. Applicable for TSYS (tsys), VPC, Elavon Americas (elavonamericas), FDI Global (fdiglobal), GPX (gpx), Barclays (barclays2) and American Express Direct (amexdirect) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th></tr></thead> <tr><td>Barclays</td><td>cnp, cp, hybrid</td><td>No</td></tr> <tr><td>American Express Direct</td><td>cp, cnp, hybrid</td><td>No</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommonProcessors */ enhancedData?: string; /** * Indicates whether the merchant is compliant with Hotel and Motel Fire Safety Act of 1990. Applicable for GPX (gpx) and VPC processors. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ fireSafetyIndicator?: boolean; /** * To enable quasi-cash transactions. A quasi-cash transaction is a cash-like transaction for the sale of items that are directly convertible to cash, such as:- Casino gaming chips, Money orders, Wire transfers. Applicable for GPX (gpx), TSYS (tsys), Barclays (barclays2) and VPC processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>Barclays</td><td>cnp, cp, hybrid</td><td>No</td><td>No</td></tr> </table> * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ quasiCash?: boolean; /** * Identifier assigned by the acquirer. Applicable for RUPAY, VPC and Six (six) processors. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ acquirerMerchantId?: string; /** * Enables Enhanced AVS/Automated Address Verification Plus (AAV+). Valid values: \"basic\" - Standard address verification system. When a processor supports AVS for a transaction's card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address. When a customer provides incorrect information, the transaction might be fraudulent. \"basic + name\" - Enhanced address verification system. Consists of the standard AVS functionality plus verification of some additional fields. The additional fields that are verified for Enhanced AVS are: - customer_firstname - customer_lastname \"basic + name + shipto\" - Automated address verification plus. Consists of the Enhanced AVS functionality plus verification of some additional fields. AAV+ intended for merchants who deliver physical goods to a different address than the billing address. AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first. For information about Enhanced AVS - The additional fields that are verified for AAV+ are: - ship_to_firstname - ship_to_lastname - ship_to_address1 - ship_to_country - ship_to_zip - ship_to_phone - customer_phone(American Express Direct only) Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>basic</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommonProcessors */ avsFormat?: string; /** * Amex Direct specific merchant config value which determines what length (either 9 or Unique 12-char reference number) of reference number will be CYBS generated if the merchant does not pass in a trans_ref_no. Can be any combination of alpha, numeric and special characters, and/or binary data in hexadecimal. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, cnp, hybrid</td><td>No</td><td>No</td></tr> </table> * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableLongTransRefNo?: boolean; /** * Field that indicates whether merchant will send level 2 data for Amex cards. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, cnp, hybrid</td><td>No</td><td>No</td></tr> </table> * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableLevel2?: boolean; /** * This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, cnp, hybrid</td><td>No</td><td>No</td></tr> </table> * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableMultipleTransactionAdviceAddendum?: boolean; /** * Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td><td>1</td><td>40</td><td>^[0-9a-zA-Z\-\\s.]+$</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommonProcessors */ amexTransactionAdviceAddendum1?: string; /** * This flag is related to offer/line item details to be included instead of sending one line item, and a grand total. Example, offer0, offer 1...offer n. Applicable for American Express Direct (amexdirect) and Elavon Americas (elavonamericas) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, cnp, hybrid</td><td>No</td><td>No</td></tr> </table> * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableMultiLineItems?: boolean; /** * To enable merchant to send in transaction reference number (unique reconciliation ID). Applicable for VPC, Vero (vero), FDI Global (fdiglobal), Six (six), CB2A, CUP, VPC, Chase Paymentech Salem (chasepaymentechsalem), Fiserv (fiserv), Elavon Americas (elavonamericas) and EFTPOS processors. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableTransactionReferenceNumber?: boolean; /** * Enables to meet the Visa mandate requirements to reverse unused authorizations, benefitting the customer by releasing the hold on unused credit card funds. Applicable for CB2A, Elavon Americas (elavonamericas), Six (six), VPC and American Express Direct (amexdirect) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, cnp, hybrid</td><td>No</td><td>No</td></tr> </table> * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableAutoAuthReversalAfterVoid?: boolean; /** * When this is enabled, authorization responses from American Express expresspay transactions include the Primary Account Number (PAN) and expiration date of the card. Applicable for American Express Direct (amexdirect) processor. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableExpresspayPanTranslation?: boolean; /** * Authorizes a credit. Reduces refund chargebacks and prevents customers from seeing the online update for credits which are otherwise offline settlements. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableCreditAuth?: boolean; /** * Field used to identify the industry type of the merchant submitting the authorization request. Valid values: `0` – unknown or unsure `A` – auto rental (EMV supported) `B` – bank/financial institution (EMV supported) `D` – direct marketing `F` – food/restaurant (EMV supported) `G` – grocery store/super market (EMV supported) `H` – hotel (EMV supported) `L` – limited amount terminal (EMV supported) `O` – oil company/automated fueling system (EMV supported) `P` – passenger transport (EMV supported) `R` – retail (EMV supported) Applicable for TSYS (tsys), RUPAY and Elavon Americas (elavonamericas) processors. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ industryCode?: CardProcessingConfigCommonProcessorsIndustryCodeEnum; /** * Field that indicates whether merchant will send level 2 data for Amex cards. Applicable for TSYS (tsys) processor. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ sendAmexLevel2Data?: boolean; /** * A soft descriptor is a text, rendered on a cardholder's statement, describing a particular product or service, purchased by the cardholder. Descriptors are intended to help the cardholder identify the products or services purchased. Valid values: `1` - trans_ref_no `2` - merchant_descriptor `3` - trans_ref_no and merchant_descriptor Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ softDescriptorType?: string; /** * V-number provided by TSYS info. The leading `V` must be replaced by a `7`. For example, replace `V1234567` with `71234567`. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ vitalNumber?: string; /** * 6 digit agent bank number provided by acquirer. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ bankNumber?: string; /** * 6 digit chain number provided by acquirer. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ chainNumber?: string; /** * 6 digits acquirer bank identification number. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ merchantBinNumber?: string; /** * 5 digit merchant location number. Unless otherwise specified by merchant's bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ merchantLocationNumber?: string; /** * 4 digits number used to identify a specific merchant store location within the member systems. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ storeID?: string; /** * Contains travel agency code if airline ticket was issued by a travel agency. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ travelAgencyCode?: string; /** * Contains travel agency name if airline ticket was issued by travel agency. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ travelAgencyName?: string; /** * This field is used to indicate Merchant's settlement currency. [ISO 4217 ALPHA-3 Standard Currency Codes] Applicable for TSYS (tsys) and Streamline (streamline2) processors. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ settlementCurrency?: string; /** * Indicates whether Least Cost Routing is enabled. Applicable for EFTPOS and CUP processors. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableLeastCostRouting?: boolean; /** * This field denotes EFTPOS Merchant's choice of receiving CVV Processing Response in return. Applicable for EFTPOS processors. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableCVVResponseIndicator?: boolean; /** * Applicable for Barclays (barclays2) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>Barclays</td><td>cnp, cp, hybrid</td><td>No</td><td>Yes</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommonProcessors */ enableMultiCurrencyProcessing?: string; /** * 'POS Network Switching' or 'Alternate Routing' means merchant can process PIN Debit transactions without a PIN. Set the value to 'Yes' if it is supported. Applicable for FDI Global (fdiglobal) processor. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enablePosNetworkSwitching?: boolean; /** * Enable dynamic currency conversion for a merchant. * @type {boolean} * @memberof CardProcessingConfigCommonProcessors */ enableDynamicCurrencyConversion?: boolean; /** * Merchant Tier defines the type of merchant, the numeric Merchant Tier value is allocated by EFTPOS. Applicable for EFTPOS processors. * @type {string} * @memberof CardProcessingConfigCommonProcessors */ merchantTier?: string; } /** * @export * @enum {string} */ export declare enum CardProcessingConfigCommonProcessorsIndustryCodeEnum { _0 = "0", A = "A", B = "B", D = "D", F = "F", G = "G", H = "H", L = "L", O = "O", P = "P", R = "R" }