@paciolan/cybersource-sdk/dist/models/riskv1decisions-consumer-authentication-information.d.ts

CyberSource REST API Typescript 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 { Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication } from './riskv1decisions-consumer-authentication-information-strong-authentication';
/**
 *
 * @export
 * @interface Riskv1decisionsConsumerAuthenticationInformation
 */
export interface Riskv1decisionsConsumerAuthenticationInformation {
    /**
     *
     * @type {Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    strongAuthentication?: Riskv1decisionsConsumerAuthenticationInformationStrongAuthentication;
    /**
     * 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.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    authenticationType?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    acsWindowSize?: string;
    /**
     * Data that documents and supports a specific authentication process.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    alternateAuthenticationData?: string;
    /**
     * Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    alternateAuthenticationDate?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    alternateAuthenticationMethod?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    authenticationDate?: string;
    /**
     * 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.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    authenticationTransactionId?: string;
    /**
     * 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
     * @type {number}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    transactionFlowIndicator?: number;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    challengeCancelCode?: string;
    /**
     * 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`.  For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html)
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    challengeCode?: string;
    /**
     * 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.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    challengeStatus?: string;
    /**
     * 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.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    customerCardAlias?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    decoupledAuthenticationIndicator?: string;
    /**
     * 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.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    decoupledAuthenticationMaxTime?: string;
    /**
     * Indicates that the card being used is the one designated as the primary payment card for purchase. Recommended for Discover ProtectBuy.
     * @type {boolean}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    defaultCard?: boolean;
    /**
     * Determines the channel that the transaction came through. Possible Values: SDK/Browser/3RI. 3RI - 3DS request initiated.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    deviceChannel?: string;
    /**
     * 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.
     * @type {number}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    installmentTotalCount?: number;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    merchantFraudRate?: string;
    /**
     * Indicates whether the customer has opted in for marketing offers. Recommended for Discover ProtectBuy.
     * @type {boolean}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    marketingOptIn?: boolean;
    /**
     * Indicates origin of the marketing offer. Recommended for Discover ProtectBuy.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    marketingSource?: string;
    /**
     * Merchant category code. **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    mcc?: string;
    /**
     * Risk Score provided by merchants. This is specific for CB transactions.
     * @type {number}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    merchantScore?: number;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    messageCategory?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    npaCode?: string;
    /**
     * 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.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    overridePaymentMethod?: string;
    /**
     * Two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)..
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    overrideCountryCode?: string;
    /**
     * This field carry data that the ACS can use to verify the authentication process.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    priorAuthenticationData?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    priorAuthenticationMethod?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    priorAuthenticationReferenceId?: string;
    /**
     * Date and time in UTC of the prior cardholder authentication. Format – YYYYMMDDHHMM
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    priorAuthenticationTime?: string;
    /**
     * 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.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    productCode?: string;
    /**
     * 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.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    returnUrl?: string;
    /**
     * Cardinal's directory server assigned 3DS Requestor ID value
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    requestorId?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    requestorInitiatedAuthenticationIndicator?: string;
    /**
     * Cardinal's directory server assigned 3DS Requestor Name value
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    requestorName?: string;
    /**
     * Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration.
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    referenceId?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    sdkMaxTimeout?: string;
    /**
     * Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies. Possible Values : 0/1
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    secureCorporatePaymentIndicator?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    transactionMode?: string;
    /**
     * 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
     * @type {string}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    whiteListStatus?: string;
    /**
     * Risk Assessment from Mastercard. This is to be sent by merchant if they would like to request a score
     * @type {number}
     * @memberof Riskv1decisionsConsumerAuthenticationInformation
     */
    scoreRequest?: number;
}