@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 { Ptsv2paymentsMerchantInformationMerchantDescriptor } from './ptsv2payments-merchant-information-merchant-descriptor'; import { Ptsv2paymentsMerchantInformationServiceFeeDescriptor } from './ptsv2payments-merchant-information-service-fee-descriptor'; import { Ptsv2paymentsMerchantInformationServiceLocation } from './ptsv2payments-merchant-information-service-location'; /** * * @export * @interface Ptsv2paymentsMerchantInformation */ export interface Ptsv2paymentsMerchantInformation { /** * * @type {Ptsv2paymentsMerchantInformationMerchantDescriptor} * @memberof Ptsv2paymentsMerchantInformation */ merchantDescriptor?: Ptsv2paymentsMerchantInformationMerchantDescriptor; /** * This field will contain either the merchant url or the reverse domain as per the requirement for DSRP Format 3. This might vary transaction to transaction and might not be static. Merchant needs to have access to send this value for all DSRP program. * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ domainName?: string; /** * Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ salesOrganizationId?: string; /** * The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code * @type {number} * @memberof Ptsv2paymentsMerchantInformation */ categoryCode?: number; /** * Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the `merchant_category_code` field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct. * @type {number} * @memberof Ptsv2paymentsMerchantInformation */ categoryCodeDomestic?: number; /** * Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ taxId?: string; /** * 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. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ vatRegistrationNumber?: string; /** * Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ cardAcceptorReferenceNumber?: string; /** * Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where: - `YYYY` = year - `MM` = month - `DD` = day - `hh` = hour - `mm` = minutes - `ss` = seconds #### Used by **Authorization** Required for these processors: - American Express Direct - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX Optional for all other processors. * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ transactionLocalDateTime?: string; /** * * @type {Ptsv2paymentsMerchantInformationServiceFeeDescriptor} * @memberof Ptsv2paymentsMerchantInformation */ serviceFeeDescriptor?: Ptsv2paymentsMerchantInformationServiceFeeDescriptor; /** * customer would be redirected to this url based on the decision of the transaction * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ cancelUrl?: string; /** * customer would be redirected to this url based on the decision of the transaction * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ successUrl?: string; /** * customer would be redirected to this url based on the decision of the transaction * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ failureUrl?: string; /** * URL for displaying payment results to the consumer (notifications) after the transaction is processed. Usually this URL belongs to merchant and its behavior is defined by merchant * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ returnUrl?: string; /** * #### Visa Platform Connect This field may be used for transactions on accounts issued under co-branding agreements when one of the co-branding partners. * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ partnerIdCode?: string; /** * * @type {Ptsv2paymentsMerchantInformationServiceLocation} * @memberof Ptsv2paymentsMerchantInformation */ serviceLocation?: Ptsv2paymentsMerchantInformationServiceLocation; /** * Free-form text field. * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ noteToBuyer?: string; /** * Use this field only if you are requesting payment with Payer Authentication serice together. 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. * @type {string} * @memberof Ptsv2paymentsMerchantInformation */ merchantName?: string; }