@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 { CardProcessingConfigCommonMerchantDescriptorInformation } from './card-processing-config-common-merchant-descriptor-information'; import { CardProcessingConfigCommonProcessors } from './card-processing-config-common-processors'; /** * * @export * @interface CardProcessingConfigCommon */ export interface CardProcessingConfigCommon { /** * e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpngsapv3 * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor> * @type {{ [key: string]: CardProcessingConfigCommonProcessors; }} * @memberof CardProcessingConfigCommon */ processors?: { [key: string]: CardProcessingConfigCommonProcessors; }; /** * Vendor code assigned by American Express. Applicable for TSYS (tsys) processor. * @type {string} * @memberof CardProcessingConfigCommon */ amexVendorCode?: string; /** * Authorization Finality indicator. Please note that the input can be in small case or capitals but response is in small case as of now. It will be made capitals everywhere in the next version. Applicable for Elavon Americas (elavonamericas), TSYS (tsys), Barclays (barclays2), Streamline (streamline2), Six (six), Barclays HISO (barclayshiso), GPN (gpn), FDI Global (fdiglobal), GPX (gpx), Paymentech Tampa (paymentechtampa), FDC Nashville (smartfdc), VPC and Chase Paymentech Salem (chasepaymentechsalem) 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>FINAL</td></tr> <tr><td>Barclays HISO</td><td>cnp, cp, hybrid</td><td>Yes</td><td>FINAL</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommon */ defaultAuthTypeCode?: CardProcessingConfigCommonDefaultAuthTypeCodeEnum; /** * MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa. Applicable for VPC, GPX (gpx) and FDI Global (fdiglobal) processors. * @type {string} * @memberof CardProcessingConfigCommon */ masterCardAssignedId?: string; /** * Allow merchants to accept partial authorization approvals. Applicable for Elavon Americas (elavonamericas), VPC, GPX (gpx), FDI Global (fdiglobal), FDC Nashville (smartfdc), GPN (gpn), TSYS (tsys), American Express Direct (amexdirect), Paymentech Tampa (paymentechtampa) and Chase Paymentech Salem (chasepaymentechsalem) 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>cnp, cp, hybrid</td><td>No</td><td>No</td></tr> </table> * @type {boolean} * @memberof CardProcessingConfigCommon */ enablePartialAuth?: boolean; /** * Indicates type of business product or service of the merchant. Applicable for Chase Paymentech Salem (chasepaymentechsalem), FDI Global (fdiglobal), RUPAY, Elavon Americas (elavonamericas), American Express Direct (amexdirect), CMCIC (cmcic), GPX (gpx), VPC, TSYS (tsys), EFTPOS, CUP, Paymentech Tampa (paymentechtampa), CB2A, Barclays (barclays2), Prisma (prisma) and GPN (gpn) 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>Barclays</td><td>cnp</td><td>No</td><td>4</td><td>4</td><td>^[0-9]+$</td></tr> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>4</td><td>4</td><td>^[0-9]+$</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommon */ merchantCategoryCode?: string; /** * 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 CardProcessingConfigCommon */ sicCode?: string; /** * Food and Consumer Service ID. Identifies the merchant as being certified and approved to accept Food Stamps. Applicable for GPX (gpx) processor. * @type {string} * @memberof CardProcessingConfigCommon */ foodAndConsumerServiceId?: string; /** * Enables you to split an order into multiple shipments with multiple captures. This feature is provided by CyberSource and supports three different scenarios: * multiple authorizations * multiple captures * multiple authorizations with multiple captures Applicable for VPC processors. * @type {boolean} * @memberof CardProcessingConfigCommon */ enableSplitShipment?: boolean; /** * Reduces your interchange fees by using automatic authorization refresh and automatic partial authorization reversal. Applicable for VPC processors. * @type {boolean} * @memberof CardProcessingConfigCommon */ enableInterchangeOptimization?: boolean; /** * Identifier provided to merchants who opt for Visa's delegated authorization program. Applicable for VPC processors. * @type {string} * @memberof CardProcessingConfigCommon */ visaDelegatedAuthenticationId?: string; /** * Blocks over-refunds when the aggregated refund amount is higher than the percentage set for this field. Applicable for GPX (gpx), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors. * @type {string} * @memberof CardProcessingConfigCommon */ creditCardRefundLimitPercent?: string; /** * Limits refunds to the percentage set in this field. Applicable for GPX (gpx) and VPC processors. * @type {string} * @memberof CardProcessingConfigCommon */ businessCenterCreditCardRefundLimitPercent?: string; /** * Enables this merchant account to capture amounts greater than the authorization amount. Applicable for GPX (gpx), VPC, Paymentech Tampa (paymentechtampa) and Chase Paymentech Salem (chasepaymentechsalem) processors. * @type {boolean} * @memberof CardProcessingConfigCommon */ allowCapturesGreaterThanAuthorizations?: boolean; /** * Helps prevent duplicate transactions. Applicable for VPC, GPX (gpx) and Chase Paymentech Salem (chasepaymentechsalem) processors. * @type {boolean} * @memberof CardProcessingConfigCommon */ enableDuplicateMerchantReferenceNumberBlocking?: boolean; /** * This is a local merchant ID used by merchants in addition to the conventional merchant ID. This value is sent to the issuer. Applicable for VPC and Prisma (prisma) processors. * @type {boolean} * @memberof CardProcessingConfigCommon */ domesticMerchantId?: boolean; /** * Indicates whether merchant processes Level 3 transactions. Applicable for TSYS (tsys), Barclays (barclays2), Paymentech Tampa (paymentechtampa), FDI Global (fdiglobal), Elavon Americas (elavonamericas) and Chase Paymentech Salem (chasepaymentechsalem) 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</td><td>No</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommon */ processLevel3Data?: string; /** * The ID assigned to the sub-merchant. 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>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>20</td><td>^[0-9a-zA-Z\-\_\,\\s.]+$</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommon */ subMerchantId?: string; /** * Sub-merchant's business name. 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>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>37</td><td>^[0-9a-zA-Z\-\_\,\\s.]+$</td></tr> </table> * @type {string} * @memberof CardProcessingConfigCommon */ subMerchantBusinessName?: string; /** * It denotes merchant's preference on secondary brand for routing in case of co-branded cards. Applicable for EFTPOS processors. * @type {boolean} * @memberof CardProcessingConfigCommon */ preferCobadgedSecondaryBrand?: boolean; /** * * @type {CardProcessingConfigCommonMerchantDescriptorInformation} * @memberof CardProcessingConfigCommon */ merchantDescriptorInformation?: CardProcessingConfigCommonMerchantDescriptorInformation; } /** * @export * @enum {string} */ export declare enum CardProcessingConfigCommonDefaultAuthTypeCodeEnum { PRE = "PRE", FINAL = "FINAL", UNDEFINED = "UNDEFINED" }