@netceterapx/click-to-pay-sdk 2.0.0 → 2.1.0

package/index.d.ts

@@ -0,0 +1,910 @@
+export declare interface AmexInitParams {
+    /**
+     * A unique id used to track the user journey. This is used for
+     * analytics to be able to correlate a single user "session" from
+     * button impression to the end of the transaction.
+     * This field may be created on the merchant page by the SRC
+     * Initiator and need to be passed-through to all the networks (SRC
+     * Systems). It is passed all the way to the DCFs as well.
+     */
+    srcInitiatorId: string;
+    /**
+     * SRCI identifier. This is generated by the SRC System during
+     * onboarding.
+     */
+    srciTransactionId: string;
+    dpaData: DpaData;
+    dpaTransactionOptions: DpaTransactionOptions;
+}
+
+export declare enum ButtonStyle {
+    FILLED = "FILLED",
+    OUTLINED = "OUTLINED"
+}
+
+export declare interface Card {
+    primaryAccountNumber: string;
+    panExpirationMonth: string;
+    panExpirationYear: string;
+    cardSecurityCode: string;
+}
+
+export declare type ComplianceResourceURLs = {
+    termsAndConditionsUrl: string;
+    privacyPolicyUrl: string;
+};
+
+export declare interface Config {
+    iframe?: ConfigIframe;
+    mastercard?: MastercardInitConfiguration;
+    visa?: VisaInitConfiguration;
+    amex?: Omit<AmexInitParams, 'srciTransactionId'>;
+}
+
+export declare interface ConfigIframe {
+    ref: HTMLIFrameElement;
+    handlers?: {
+        onDcfShow: () => void;
+        onDcfHide: () => void;
+    };
+}
+
+export declare interface ConsumerStatusEvent {
+    /**
+     * Informs whether consumer was recognized by detecting a cookie in the browser set by the SRC System.
+     */
+    isRecognized: boolean;
+    /**
+     * Informs whether consumer has a profile in any of the SRC Systems.
+     */
+    hasProfile: boolean;
+    /**
+     * Informs whether consumer has saved cards in any of the SRC Systems.
+     */
+    hasCards: boolean;
+    /**
+     * Gives a list of Schemes that the user has a profile in.
+     */
+    hasProfileInSchemes: CreditCardBrand[];
+    /**
+     * Informs whether the manual card entry form should be open by default.
+     * Is true when the consumer doesn't have a profile or has a profile but no cards.
+     */
+    manualCardEntryMandatory: boolean;
+}
+
+export declare enum CreditCardBrand {
+    MASTERCARD = "Mastercard",
+    VISA = "Visa",
+    AMEX = "Amex"
+}
+
+export declare enum DcfOpeningBehaviour {
+    /**
+     * Replaces the SRC UI and inplace shows the DCF window.
+     */
+    REPLACE = "replace",
+    /**
+     * Shows the DCF window as a modal. With backdrop from the DCF window.
+     */
+    FULL = "full",
+    /**
+     * Allows the DCF to show it's own iframe. (They default to popup iframe).
+     */
+    POPUP = "popup"
+}
+
+export declare interface DpaData {
+    /**
+     * Display name of the DPA.
+     * Ex. ‘Disney Online’.
+     */
+    dpaPresentationName: string;
+    /**
+     * Website URL
+     * Ex. ‘http://www.disneyonline.com’
+     */
+    dpaUri?: string;
+    /**
+     * Undocumented parameter.
+     */
+    dpaName: string;
+}
+
+export declare interface DpaTransactionOptions {
+    threeDsPreference: ThreeDsPreference;
+}
+
+export declare enum EnablePerformanceMeasurement {
+    TRUE = "true",
+    FALSE = "false"
+}
+
+export declare enum Environment {
+    SANDBOX = "SANDBOX",
+    PRODUCTION = "PRODUCTION"
+}
+
+export declare interface HeadlessCheckoutParams {
+    /**
+     * The payment card details.
+     * Required.
+     */
+    card: Card;
+    /**
+     * The iframe which the DCF will load.
+     * Conditional.
+     * Required only for Mastercard.
+     */
+    iframeRef?: HTMLIFrameElement;
+    /**
+     * DPA configuration data, which can be used to override the DPA configuration provided during the initial configuration of the component.
+     */
+    dpaTransactionOptions?: VisaDpaTransactionOptions | MastercardDpaTransactionOptions;
+    /**
+     * The consumer's Click to Pay profile details.
+     * Conditional.
+     * Required for Visa.
+     * Required for MasterCard only when adding a card and no MasterCard profile is present in the SRC System.
+     */
+    profileDetails?: ProfileDetails;
+    /**
+     * Flag to indicate if the user wants to skip verification next time. If set to true, the Scheme will drop a cookie to ensure that user is recognized on this device.
+     * Optional.
+     * Valid only for Mastercard.
+     */
+    skipVerificationNextTime?: boolean;
+    /**
+     * Compliance resources URLs the user agreed to.
+     * Conditional.
+     * Required only for Visa.
+     * Provide the compliance resources fetched through the `getComplianceResourceURLsForVisa()` method.
+     */
+    complianceResourceURLs?: ComplianceResourceURLs;
+}
+
+export declare enum HidePayButton {
+    TRUE = "true",
+    FALSE = "false"
+}
+
+export declare enum IsExpanded {
+    TRUE = "true",
+    FALSE = "false"
+}
+
+export declare enum IsPanInPayButton {
+    TRUE = "true",
+    FALSE = "false"
+}
+
+/**
+ * Supported languages.
+ */
+export declare enum LANG {
+    /** Arabic - United Arab Emirates */
+    ar_AE = "ar_AE",
+    /** Arabic - Saudi Arabia */
+    ar_SA = "ar_SA",
+    /** Bulgarian - Bulgaria */
+    bg_BG = "bg_BG",
+    /** Czech - Czechia */
+    cs_CZ = "cs_CZ",
+    /** Danish - Denmark */
+    da_DA = "da_DA",
+    /** German - Austria */
+    de_AT = "de_AT",
+    /** German - Germany */
+    de_DE = "de_DE",
+    /** Greek - Greece */
+    el_GR = "el_GR",
+    /** English - United Kingdom */
+    en_UK = "en_UK",
+    /** English - United States of America */
+    en_US = "en_US",
+    /** Spanish - Spain */
+    es_ES = "es_ES",
+    /** Finnish - Finland */
+    fi_FI = "fi_FI",
+    /** French - France */
+    fr_FR = "fr_FR",
+    /** Croatian - Croatia */
+    hr_HR = "hr_HR",
+    /** Hungarian - Hungary */
+    hu_HU = "hu_HU",
+    /** Italian - Italy */
+    it_IT = "it_IT",
+    /** Japanese - Japan */
+    ja_JP = "ja_JP",
+    /** Latvian - Latvia */
+    lv_LV = "lv_LV",
+    /** Dutch - Belgium */
+    nl_BE = "nl_BE",
+    /** Dutch - Nederland */
+    nl_NL = "nl_NL",
+    /** Norwegian - Norway */
+    no_NO = "no_NO",
+    /** Polish - Poland */
+    pl_PL = "pl_PL",
+    /** Portuguese - Portugal */
+    pt_PT = "pt_PT",
+    /** Romanian - Romania */
+    ro_RO = "ro_RO",
+    /** Russian - Russian */
+    ru_RU = "ru_RU",
+    /** Slovak - Slovakia */
+    sk_SK = "sk_SK",
+    /** Slovenian - Slovenia */
+    sl_SL = "sl_SL",
+    /** Swedish - Finland */
+    sv_FI = "sv_FI",
+    /** Swedish - Sweden */
+    sv_SE = "sv_SE",
+    /** Ukrainian - Ukraine */
+    uk_UA = "uk_UA",
+    /** Vietnamese - Vietnam */
+    vi_VN = "vi_VN"
+}
+
+export declare type MastercardCustomInputData = {
+    /**
+     * Configure when card enrollment is offered to the cardholder. This only applies to Mastercard cards.
+     * Valid values for enum:
+     * • WITHIN_CHECKOUT – This experience offers Click to Pay as a payment option to complete Checkout for an order. (Guest Checkout Option)
+     * • PAYMENT_SETTINGS – This experience offers Click to Pay to enroll and add their cards for faster checkout. (No Guest Checkout Option)
+     * Either one of these values must be set to enable Embedded checkout experience along with confirmPayment parameter.
+     */
+    'com.mastercard.dcfExperience'?: MastercardCustomInputDataEnum;
+};
+
+export declare enum MastercardCustomInputDataEnum {
+    WITHIN_CHECKOUT = "WITHIN_CHECKOUT",
+    PAYMENT_SETTINGS = "PAYMENT_SETTINGS"
+}
+
+export declare enum MastercardDpaBillingPreferenceEnum {
+    FULL = "FULL",
+    NONE = "NONE",
+    POSTAL_COUNTRY = "POSTAL_COUNTRY"
+}
+
+/**
+ * May be provided, as required, to dynamically update previously registered DPA Data, e.g., presentation name.
+ */
+export declare type MastercardDpaData = {
+    /**
+     * Display name of the DPA website.
+     */
+    dpaPresentationName?: string;
+    /**
+     * URL of the DPA website.
+     */
+    dpaUri?: string;
+};
+
+export declare enum MastercardDpaShippingPreferenceEnum {
+    FULL = "FULL",
+    NONE = "NONE"
+}
+
+/**
+ * DPA-specific preferences and transaction configuration parameters.
+ * This is required for the init method, and may also be included in the checkout method.
+ */
+export declare type MastercardDpaTransactionOptions = {
+    /**
+     * Merchant site preferred locale.
+     * Format: ISO language_country pair (e.g., en_US ).
+     * This is needed to ensure correct language and user experience.
+     * The value of the dpaLocale will be used by Mastercard SRC to create user profile and deliver Click to Pay experience by default.
+     * Users can choose to change the default country/language passed in dpaLocale from a country/language selection option in the DCF screen before profile creation.
+     * If users opt to choose that, then the profile will be created in the user selected country and language
+     * and the same will also be used to deliver the experience in all future checkouts by the same user.
+     */
+    dpaLocale: string;
+    /**
+     * Note: Mastercard does not currently support declining payments based on the cardholder’s billing address.
+     * You should specify an empty array.
+     */
+    dpaAcceptedBillingCountries?: string[];
+    /**
+     * Shipping restrictions.
+     * Format: ISO 3166-1 alpha-2 format.
+     * Shipping region country codes that limits the selection of eligible shipping addresses.
+     * If this list is empty, then it means all countries are accepted.
+     */
+    dpaAcceptedShippingCountries?: string[];
+    /**
+     * Verbosity of billing address required by the DPA.
+     * Valid values for enum:
+     * • FULL
+     * • NONE
+     * • POSTAL_COUNTRY
+     * If not provided, the default is NONE.
+     */
+    dpaBillingPreference?: MastercardDpaBillingPreferenceEnum;
+    /**
+     * Verbosity of shipping address required by the DPA.
+     * Valid values for enum:
+     * • FULL
+     * • NONE
+     * If not provided the default is FULL.
+     */
+    dpaShippingPreference?: MastercardDpaShippingPreferenceEnum;
+    /**
+     * Flag to indicate if the consumer name is requested or not.
+     * Default is true.
+     */
+    consumerNameRequested?: boolean;
+    /**
+     * Flag to indicate if the consumer email address is requested or not.
+     * Default is true.
+     */
+    consumerEmailAddressRequested?: boolean;
+    /**
+     * Flag to indicate if the consumer phone number is requested or not.
+     * Default is true.
+     */
+    consumerPhoneNumberRequested?: boolean;
+    /**
+     * Payment options requested by the DPA.
+     */
+    paymentOptions?: MastercardPaymentOptions;
+    /**
+     * Note: Not currently supported by Mastercard SRC.
+     */
+    transactionType?: unknown;
+    /**
+     * Container for amount and currency code.
+     */
+    transactionAmount?: MastercardTransactionAmount;
+    /**
+     * Whether this is a guest checkout.
+     */
+    isGuestCheckout?: boolean;
+    /**
+     * Note: Not currently supported by Mastercard SRC.
+     */
+    payloadTypeIndicatorCheckout?: unknown;
+    /**
+     * Note: Not currently supported by Mastercard SRC.
+     */
+    payloadTypeIndicatorPayload?: unknown;
+    /**
+     * Extensible container that allows DPA to pass a network specific set of data to Click to Pay System.
+     */
+    customInputData?: MastercardCustomInputData;
+    /**
+     * Key parameter to distinguish if a network-specific DCF or a loading screen is displayed after card selection.
+     * Default is FALSE.
+     * When set to False, consumer is prompted to ‘Continue’ the payment on a loading screen; when set to True, consumer is prompted with a Confirm payment message on DCF.
+     */
+    confirmPayment?: boolean;
+};
+
+export declare enum MastercardDynamicDataTypeEnum {
+    CARD_APPLICATION_CRYPTOGRAM_SHORT_FORM = "CARD_APPLICATION_CRYPTOGRAM_SHORT_FORM"
+}
+
+export declare type MastercardInitConfiguration = {
+    /**
+     * Identifier for the integrator. This is generated by the Mastercard System during onboarding.
+     */
+    srcInitiatorId: string;
+    /**
+     * DPA Identifier. This is generated by the integrator during registration.
+     */
+    srciDpaId: string;
+    /**
+     * DPA-specific preferences and transaction configuration parameters.
+     */
+    dpaTransactionOptions: MastercardDpaTransactionOptions;
+    /**
+     * May be provided, as required, to dynamically update previously registered DPA Data, e.g., presentation name.
+     */
+    dpaData?: MastercardDpaData;
+};
+
+export declare type MastercardPaymentOptions = {
+    /**
+     * Note: Not currently supported by Mastercard SRC
+     */
+    dpaDynamicDataTtlMinutes?: number;
+    /**
+     * Type of crytogram or token used for the card data.
+     * Valid values for enum:
+     * • CARD_APPLICATION_CRYPTOGRAM_SHORT_FORM for DSRP format
+     */
+    dynamicDataType?: MastercardDynamicDataTypeEnum;
+};
+
+export declare type MastercardTransactionAmount = {
+    /**
+     * Transaction amount given in the format corresponding to the ISO 4217 currency code specified by transactionCurrencyCode.
+     * For example if the currency is USD, a transaction of $100 would be given as ‘100.00’. Note that the decimal
+     * separator should be a dot (.) and the number of digits required after the separator depends on the currency used.
+     * Ensure you use the correct precision at all times.
+     */
+    transactionAmount: string;
+    /**
+     * String specifying the ISO 4217 currency code (e.g., USD)
+     */
+    transactionCurrencyCode: string;
+};
+
+/**
+ * Merchant provides configuration for modifying component.
+ */
+export declare interface MerchantConfig {
+    isExpanded: IsExpanded;
+    locale: LANG;
+    email: string | undefined;
+    dcfOpeningBehaviour: DcfOpeningBehaviour;
+    dpaPresentationName: string | undefined;
+    transactionAmount: TransactionAmount;
+    isPanInPayButton: IsPanInPayButton;
+    buttonStyle: ButtonStyle;
+    hidePayButton: HidePayButton;
+    enablePerformanceMeasurement: EnablePerformanceMeasurement;
+}
+
+export declare const messageTimeout = 3000;
+
+export declare enum OrchestratorErrorReason {
+    NOT_AUTHENTICATED = "NOT_AUTHENTICATED"
+}
+
+export declare type ProfileDetails = {
+    firstName: string;
+    lastName: string;
+    fullName: string;
+    email: string;
+    country: string;
+    languageCode: string;
+    mobileNumber: {
+        /**
+         * Length = 1 to 4 digits. Phone number country code. International calling code format.
+         */
+        countryCode: string;
+        /**
+         * Length = 4 to 14 digits. Phone number without country code.
+         */
+        phoneNumber: string;
+    };
+    billingAddress?: {
+        /**
+         * Example: US.
+         */
+        countryCode: string;
+        /**
+         * The city associated with the address
+         */
+        city?: string;
+        /**
+         * The state associated with the address
+         */
+        state?: string;
+        /**
+         * The zip code associated with the address.
+         */
+        zip?: string;
+        /**
+         * The recipient name for the address.
+         */
+        name?: string;
+        /**
+         * Line 1 of the address.
+         */
+        line1?: string;
+        /**
+         * Line 2 of the address.
+         */
+        line2?: string;
+        /**
+         * Line 3 of the address.
+         */
+        line3?: string;
+    };
+};
+
+export declare enum Sandbox {
+    TRUE = "true",
+    FALSE = "false"
+}
+
+export declare enum ThreeDsPreference {
+    'NONE' = "NONE",
+    'SELF' = "SELF",
+    'ONBEHALF' = "ONBEHALF"
+}
+
+export declare type TransactionAmount = {
+    /**
+     * Amount associated with transaction.
+     * Format: Numeric string with a decimal separator. Note that the decimal separator should be a dot (.)
+     */
+    amount: string;
+    /**
+     * Currency code used for the transaction amount.
+     * Format: ISO 4217 alpha-3 currency code.
+     */
+    currencyCode: string;
+};
+
+export declare type UICustomizations = {
+    buttonAndBadgeColor?: string;
+    buttonFilledHoverColor?: string;
+    buttonOutlinedHoverColor?: string;
+    buttonDisabledColor?: string;
+    cardItemActiveColor?: string;
+    buttonAndBadgeTextColor?: string;
+    linkTextColor?: string;
+    accentColor?: string;
+    fontFamily?: string;
+    buttonAndInputRadius?: string;
+    cardItemRadius?: string;
+};
+
+export declare enum VisaAuthenticationReasonEnum {
+    TRANSACTION_AUTHENTICATION = "TRANSACTION_AUTHENTICATION",
+    NOT_PREFERRED = "NOT_PREFERRED"
+}
+
+export declare enum VisaCustomFlowTypeEnum {
+    PAYMENT_SETTING = "paymentsetting",
+    WITHIN_CHECKOUT = "withincheckout"
+}
+
+export declare type VisaCustomInputData = {
+    /**
+     * Checkout orchestrator. Must be "merchant" for Merchant Orchestrated Checkout.
+     */
+    checkoutOrchestrator?: string;
+    /**
+     * Flow type indicator for SRC orchestrated flows.
+     * Valid values for enum:
+     * • paymentsetting
+     * • withincheckout
+     */
+    customFlowType?: VisaCustomFlowTypeEnum;
+};
+
+export declare enum VisaDpaBillingPreferenceEnum {
+    ALL = "ALL",
+    POSTAL_COUNTRY = "POSTAL_COUNTRY",
+    NONE = "NONE"
+}
+
+export declare type VisaDpaData = {
+    /**
+     * DPA identifier, which is generated by the SRC system during DPA registration. Required if srciDpaId is not provided
+     * in the top-level structure of the request body; optional unless you want to specify a display presentation name,
+     * the website address, or the preferred 3DS behavior.
+     * Format: String, 64 bytes
+     */
+    srciDpaId?: string;
+    /**
+     * Display name of the DPA.
+     * Example: Mycompany Online
+     */
+    dpaPresentationName?: string;
+    /**
+     * The URI for the website.
+     * Example: http://www.Mycompanyonline.com
+     */
+    dpaUri?: string;
+    /**
+     * (deprecated) This field specifies the preference of 3DS behavior specified by DPA.
+     * Valid values for enum:
+     * • ONBEHALF
+     * • SELF
+     * • NONE
+     * • UNKNOWN (default)
+     */
+    dpaThreeDsPreference?: VisaDpaThreeDsPreferenceEnum;
+};
+
+export declare enum VisaDpaShippingPreferenceEnum {
+    ALL = "ALL",
+    POSTAL_COUNTRY = "POSTAL_COUNTRY",
+    NONE = "NONE"
+}
+
+export declare enum VisaDpaThreeDsPreferenceEnum {
+    ONBEHALF = "ONBEHALF",
+    SELF = "SELF",
+    NONE = "NONE",
+    UNKNOWN = "UNKNOWN"
+}
+
+export declare type VisaDpaTransactionOptions = {
+    /**
+     * DPA’s preferred locale. This can be the same as the locale in the init parameters or can be different.
+     * Format: Based on ISO format for language (ISO 639-1) and alpha-2 country code (ISO 3166-1 alpha-2).
+     * The language and country should be separated using an underscore ( _ ).
+     * Example: en_US, fr_CA
+     */
+    dpaLocale?: string;
+    /**
+     * Billing countries. Payments from the listed billing countries are accepted.
+     * If this list is empty, all countries are accepted.
+     * Format: Array of country codes in ISO 3166-1 alpha-2 format
+     * Example: ["US”, “CA”, “AU”]
+     */
+    dpaAcceptedBillingCountries?: string[];
+    /**
+     * Shipping countries; shipping region country codes that limit the selection of eligible shipping addresses.
+     * If this list is empty, all countries are accepted.
+     * Format: Array of country codes in ISO 3166-1 alpha-2 format
+     */
+    dpaAcceptedShippingCountries?: string[];
+    /**
+     * Verbosity of billing address required by the DPA.
+     * Valid values for enum:
+     * • ALL (default)
+     * • POSTAL_COUNTRY
+     * • NONE
+     */
+    dpaBillingPreference?: VisaDpaBillingPreferenceEnum;
+    /**
+     * Extent to which DPA wants to have shipping address collected.
+     * Valid values for enum:
+     * • ALL (default)
+     * • POSTAL_COUNTRY
+     * • NONE
+     */
+    dpaShippingPreference?: VisaDpaShippingPreferenceEnum;
+    /**
+     * Whether the name of the consumer has been requested.
+     */
+    consumerNameRequested?: boolean;
+    /**
+     * Whether the email address of the consumer has been requested.
+     */
+    consumerEmailAddressRequested?: boolean;
+    /**
+     * Whether the Phone number of the consumer has been requested.
+     */
+    consumerPhoneNumberRequested?: boolean;
+    /**
+     * Payment options requested by the DPA.
+     */
+    paymentOptions?: VisaPaymentOptions;
+    /**
+     * Whether the payment will be processed immediately after selection or after confirmation.
+     * Valid values for enum:
+     * • pay – proceed after selection
+     * • continue – proceed after confirmation (default)
+     */
+    reviewAction?: VisaReviewActionEnum;
+    /**
+     * Review message to go with action.
+     */
+    checkoutDescription?: string;
+    /**
+     * Type of the transaction.
+     * Valid values for enum:
+     * • PURCHASE (default)
+     * • BILL_PAYMENT
+     * • MONEY_TRANSFER
+     */
+    transactionType?: VisaTransactionTypeEnum;
+    /**
+     * Type of orders.
+     * Valid values for enum:
+     * • REAUTHORIZATION
+     * • RECURRING
+     * • INSTALLMENT
+     */
+    orderType?: VisaOrderTypeEnum;
+    /**
+     * The verbosity of payload requested.
+     * • FULL - includes everything; all PCI & PII data (card/token, billing, shipping, consumer)
+     * • SUMMARY - (default) no JWE. If FULL needed during checkout, SRCi needs to make a request for it explicitly.
+     * • PAYMENT - same as FULL
+     * • NON_PAYMENT - only PII (billing, shipping, consumer). It has both SUMMARY and encryptedPayload without card, token, or dynamicData.
+     * • NONE - just srcCorrelationId (with COMPLETE dcfActionCode)
+     */
+    payloadTypeIndicator?: VisaPayloadTypeIndicatorEnum;
+    /**
+     * Amount of the transaction.
+     * Required when transaction authentication is performed.
+     */
+    transactionAmount?: VisaTransactionAmount;
+    /**
+     * The order identifier generated by the DPA. Typically used for reconciliation process by the DPA.
+     * Format: Universally Unique Identifier (UUID) as string
+     */
+    merchantOrderId?: string;
+    /**
+     * Code associated with Merchant Category
+     * Format: 4-digit string
+     */
+    merchantCategoryCode?: string;
+    /**
+     * The country code associated with the merchant’s billing or shipping address.
+     * Format: ISO-3166 - 1 alpha-2 standard code
+     * Example: US – United States
+     */
+    merchantCountryCode?: string;
+    /**
+     * (Deprecated) If 3DS is requested for the transaction, this attribute is required.
+     */
+    threeDSInputData?: VisaThreeDsInputData;
+    /**
+     * Custom input data elements presented to the SRC System.
+     * CustomInputData structure;
+     */
+    customInputData?: VisaCustomInputData;
+};
+
+export declare enum VisaDynamicDataTypeEnum {
+    TAVV = "TAVV",
+    DTVV = "DTVV"
+}
+
+export declare type VisaInitConfiguration = {
+    /**
+     * SRCi identifier generated by an SRC system during the onboarding process.
+     */
+    srcInitiatorId: string;
+    /**
+     * A unique ID provided by the SRCi for the DPA, which can be used as an external client ID.
+     * Required if srciDpaId in dpaData is not provided.
+     */
+    srciDpaId: string;
+    /**
+     * DPA registration data.
+     * Required if srciDpaId is not provided.
+     */
+    dpaData?: VisaDpaData;
+    /**
+     * DPA configuration data, which overrides the configuration on the SRC system that was created during DPA registration.
+     */
+    dpaTransactionOptions: VisaDpaTransactionOptions;
+    /**
+     * 3-D Secure options to execute 3DS authentication for transaction.
+     */
+    threeDSOptions: VisaThreeDSOptions;
+    /**
+     * KID (Key ID) of the encryption key to encrypt card information before sending it to Visa.
+     */
+    encryptionKey: string;
+    /**
+     * Modulus of the encryption key to encrypt card information before sending it to Visa.
+     */
+    nModulus: string;
+};
+
+export declare enum VisaOrderTypeEnum {
+    REAUTHORIZATION = "REAUTHORIZATION",
+    RECURRING = "RECURRING",
+    INSTALLMENT = "INSTALLMENT"
+}
+
+export declare enum VisaPayloadTypeIndicatorEnum {
+    FULL = "FULL",
+    SUMMARY = "SUMMARY",
+    PAYMENT = "PAYMENT",
+    NON_PAYMENT = "NON_PAYMENT",
+    NONE = "NONE"
+}
+
+export declare type VisaPaymentOptions = {
+    /**
+     * The minimum requested validity period for the transaction credentials,
+     * such as a cryptogram, returned by the SRC system, in minutes.
+     * If this is not provided, the values are determined by the SRCs.
+     */
+    dpaDynamicDataTTLMinutes?: number;
+    /**
+     * The dynamic data type.
+     * Valid values for enum:
+     * • TAVV - Transaction Authentication Verification Value
+     * • DTVV – Dynamic Token Verification Value (DEPRECATED)
+     */
+    dynamicDataType?: VisaDynamicDataTypeEnum;
+    /**
+     * Whether PAN data is requested.
+     */
+    dpaPanRequested?: boolean;
+};
+
+export declare enum VisaReviewActionEnum {
+    PAY = "pay",
+    CONTINUE = "continue"
+}
+
+export declare enum VisaThreeDSChallengeIndicator {
+    /** 01 - No preference */
+    NO_PREFERENCE = "01",
+    /** 02 - No challenge requested */
+    NO_CHALLENGE_REQUESTED = "02",
+    /** 03 - Challenge requested (3DS Requestor Preference) */
+    CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE = "03",
+    /** 04 - Challenge requested (Mandate) */
+    CHALLENGE_REQUESTED_MANDATE = "04",
+    /** 05 - No challenge requested (transactional risk analysis is already performed) */
+    NO_CHALLENGE_REQUESTED_RISK_ANALYSIS_PERFORMED = "05",
+    /** 06 - No challenge requested (Data share only) */
+    NO_CHALLENGE_REQUESTED_DATA_SHARE_ONLY = "06",
+    /** 07 - No challenge requested (strong consumer authentication is already performed) */
+    NO_CHALLENGE_REQUESTED_SCA_PERFORMED = "07",
+    /** 08 - No challenge requested (utilize trust list exemption if no challenge required) */
+    NO_CHALLENGE_REQUESTED_TRUST_LIST_EXEMPTION = "08",
+    /** 09 - Challenge requested (trust list prompt requested if challenge required) */
+    CHALLENGE_REQUESTED_TRUST_LIST_PROMPT = "09"
+}
+
+export declare type VisaThreeDsInputData = {
+    /**
+     * The ID assigned to the merchant for authentication request to initiate 3DS with MPI.
+     */
+    requestorId: string;
+    /**
+     * Merchant’s Acquirer ID
+     */
+    acquirerId: string;
+    /**
+     * Acquirer’s Merchant ID
+     */
+    acquirerMid: string;
+};
+
+export declare type VisaThreeDSOptions = {
+    /**
+     * SRCi-provided authentication reasons used by the SRC System to perform authentication.
+     * Valid values for enum:
+     * • TRANSACTION_AUTHENTICATION
+     * • NOT_PREFERRED
+     */
+    authenticationReason: VisaAuthenticationReasonEnum;
+    /**
+     * Acquirer-assigned Merchant identifier.
+     */
+    acquirerMerchantId: string;
+    /**
+     * Acquirer identification code as assigned by the Directory Server.
+     */
+    acquirerBIN: string;
+    /**
+     * Merchant name assigned by the Acquirer or Payment System.
+     */
+    merchantName: string;
+    /**
+     * A challenge indicator value related to 3DS authentication.
+     * Valid values:
+     * • 01 - No preference
+     * • 02 - No challenge requested
+     * • 03 - Challenge requested (3DS 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 trust list exemption if no challenge required)
+     * • 09 - Challenge requested (trust list prompt requested if challenge required)
+     */
+    challengeIndicator: VisaThreeDSChallengeIndicator;
+};
+
+export declare type VisaTransactionAmount = {
+    /**
+     * Amount associated with transaction.
+     * Format: Numeric string; maximum 9 digits before an optional decimal
+     * point and 4 decimal digits after
+     */
+    transactionAmount: string;
+    /**
+     * Currency code used for the transaction amount.
+     * Format: ISO 4217 alpha-3 currency code
+     */
+    transactionCurrencyCode: string;
+};
+
+export declare enum VisaTransactionTypeEnum {
+    PURCHASE = "PURCHASE",
+    BILL_PAYMENT = "BILL_PAYMENT",
+    MONEY_TRANSFER = "MONEY_TRANSFER"
+}
+
+export { }