redsys-easy

export interface ThreeDSPhone { /** Country prefix number */ cc: string; /** Phone number */ subscriber: string; } export interface ThreeDSRequestorAuthenticationInfo { /** Authentication Data */ threeDSReqAuthData: string; /** Authentication method code */ threeDSReqAuthMethod: string; /** Authentication timestamp, yyyymmddHHMM */ threeDSReqAuthTimestamp: string; } export interface ThreeDSRequestorPriorAuthenticationInfo { /** Reference */ threeDSReqPriorRef?: string | undefined; /** Authentication method code */ threeDSReqPriorAuthMethod?: string | undefined; /** Authentication timestamp, yyyymmddHHMM */ threeDSReqPriorAuthTimestamp?: string | undefined; } export interface BaseThreeDSAuthenticationDataParams { /** 3DSecure protocol version */ protocolVersion: '1.0.2' | '2.1.0' | '2.2.0'; /** 3DSecure information type */ threeDSInfo: 'AuthenticationData'; /** Challenge notification URL */ notificationURL: string; /** 3DSecure Method result indicator */ threeDSCompInd: 'Y' | 'N' | 'U'; /** 3DSecure transaction identifier */ threeDSServerTransID: string; /** * Browser Screen Color Depth * * @remarks * `screen.colorDepth.toString()` or `'1'` if javascript is disabled */ browserColorDepth: string; /** * Browser Java Enabled * * @remarks * `navigator.javaEnabled()` or `false` if javascript is disabled */ browserJavaEnabled: boolean; /** * Browser Language * * @remarks * `navigator.language` */ browserLanguage: string; /** * Browser Screen Height * * @remarks * `screen.height.toString()` or `'0'` if javascript is disabled */ browserScreenHeight: string; /** * Browser Screen Width * * @remarks * `screen.width.toString()` or `'0'` if javascript is disabled */ browserScreenWidth: string; /** * Browser Time Zone * * @remarks * `(new Date()).getTimezoneOffset().toString()` or `'0'` if javascript is disabled */ browserTZ: string; /** Browser JavaScript Enabled */ browserJavascriptEnabled: boolean; /** Browser User-Agent */ browserUserAgent: string; /** Browser Accept Header */ browserAcceptHeader: string; /** Browser IP Address, ipv4 or ipv6 */ browserIP?: string | undefined; /** Additional account information, max 64 characters */ acctID?: string | undefined; /** Account information, json */ acctInfo?: { /** Account creation ellapsed time code */ chAccAgeInd?: '01' | '02' | '03' | '04' | '05' | undefined; /** Account modification date, yyyymmdd */ chAccChange?: string | undefined; /** Account modification ellapsed time code */ chAccChangeInd?: '01' | '02' | '03' | '04' | undefined; /** Account creation date, yyyymmdd */ chAccDate?: string | undefined; /** Last password change date, yyyymmdd */ chAccPwChange?: string | undefined; /** Password change ellapsed time code */ chAccPwChangeInd?: '01' | '02' | '03' | '04' | '05' | undefined; /** Number of purchases during the last 6 months */ nbPurchaseAccount?: string | undefined; /** Attemps to add a card during the last 24 hours */ provisionAttemptsDay?: string | undefined; /** Number of transactions attempted during the last 24 hours */ txnActivityDay?: string | undefined; /** Number of transactions attempted last year */ txnActivityYear?: string | undefined; /** Card registration date, yyyymmdd */ paymentAccAge?: string | undefined; /** Card registration ellapsed time code */ paymentAccInd?: '01' | '02' | '03' | '04' | '05' | undefined; /** First usage of shipping address date, yyyymmdd */ shipAddressUsage?: string | undefined; /** First usage of shipping address ellapsed time code */ shipAddressUsageInd?: '01' | '02' | '03' | '04' | '05' | undefined; /** Cardholder shipping name indicator code */ shipNameIndicator?: '01' | '02' | undefined; /** Suspicious activity code */ suspiciousAccActivity?: '01' | '02' | undefined; } | undefined; /** Matching shipping and billing addresses indicator */ addrMatch?: 'Y' | 'N' | undefined; /** Billing address city */ billAddrCity?: string | undefined; /** Billing address line 1 */ billAddrLine1?: string | undefined; /** Billing address line 2 */ billAddrLine2?: string | undefined; /** Billing address line 3 */ billAddrLine3?: string | undefined; /** Billing address postal code */ billAddrPostCode?: string | undefined; /** Billing address state code, ISO 3166-2 */ billAddrState?: string | undefined; /** Billing address country code, ISO 3166-1 */ billAddrCountry?: string | undefined; /** Cardholder name */ cardholderName?: string | undefined; /** Challenge window size */ challengeWindowSize?: string | undefined; /** Account email address */ email?: string | undefined; /** Account landline phone number */ homePhone?: ThreeDSPhone | undefined; /** Account mobile phone number */ mobilePhone?: ThreeDSPhone | undefined; /** Account work phone number */ workPhone?: ThreeDSPhone | undefined; /** Merchant risk indicator, json */ merchantRiskIndicator?: { /** Delivery email address */ deliveryEmailAddress?: string | undefined; /** Delivery time code */ deliveryTimeframe?: '01' | '02' | '03' | '04' | undefined; /** Gift card amount */ giftCardAmount?: string | undefined; /** Count of gift cards used */ giftCardCount?: string | undefined; /** Gift card currency number, ISO-4217 */ giftCardCurr?: string | undefined; /** Preorder availability date, yyyymmdd */ preOrderDate?: string | undefined; /** Preorder availability indicator code */ preOrderPurchaseInd?: '01' | '02' | undefined; /** Reorder indicator code */ reorderItemsInd?: '01' | '02' | undefined; /** Shipping indicator code */ shipIndicator?: '01' | '02' | '03' | '04' | '05' | '06' | '07' | undefined; } | undefined; /** Number of purchase installments */ purchaseInstalData?: string | undefined; /** Recurring payments expiration date, yyyymmdd */ recurringExpiry?: string | undefined; /** Minimum number of days between recurring payments */ recurringFrequency?: string | undefined; /** Shipping address city */ shipAddrCity?: string | undefined; /** Shipping address line 1 */ shipAddrLine1?: string | undefined; /** Shipping address line 2 */ shipAddrLine2?: string | undefined; /** Shipping address line 3 */ shipAddrLine3?: string | undefined; /** Shipping address postal code */ shipAddrPostCode?: string | undefined; /** Shipping address state code, ISO 3166-2 */ shipAddrState?: string | undefined; /** Shipping address country code, ISO 3166-1 */ shipAddrCountry?: string | undefined; /** Authentication information, json */ threeDSRequestorAuthenticationInfo?: ThreeDSRequestorAuthenticationInfo | undefined; /** Previous authentication information, json */ threeDSRequestorPriorAuthenticationInfo?: ThreeDSRequestorPriorAuthenticationInfo | undefined; } /** * Browser information required by 3DS * * @remarks * The information must be obtained in the browser, for example, wusing the following function. * * @example * ``` * const obtain3DSBrowserInfo = (): ThreeDSBrowserClientInfo => { * return { * browserLanguage: navigator.language, * browserColorDepth: screen.colorDepth.toString(), * browserScreenHeight: screen.height.toString(), * browserScreenWidth: screen.width.toString(), * browserTZ: (new Date()).getTimezoneOffset().toString(), * browserJavaEnabled: navigator.javaEnabled() * }; * }; * ``` * * @public */ export type ThreeDSBrowserClientInfo = Pick<BaseThreeDSAuthenticationDataParams, 'browserLanguage' | 'browserColorDepth' | 'browserScreenHeight' | 'browserScreenWidth' | 'browserTZ' | 'browserJavaEnabled'>; export interface ThreeDSPreAuthInputParams { threeDSInfo: 'CardData'; } export interface ThreeDSv1AuthDataInputParams extends Pick<BaseThreeDSAuthenticationDataParams, 'protocolVersion' | 'threeDSInfo' | 'browserAcceptHeader' | 'browserUserAgent'> { protocolVersion: '1.0.2'; threeDSInfo: 'AuthenticationData'; } export interface ThreeDSv2AuthDataInputParams extends BaseThreeDSAuthenticationDataParams { protocolVersion: '2.1.0' | '2.2.0'; threeDSInfo: 'AuthenticationData'; } export interface ThreeDSv1ChallengeResponseInputParams { protocolVersion: '1.0.2'; threeDSInfo: 'ChallengeResponse'; PARes: string; MD: string; } export interface ThreeDSv2ChallengeResponseInputParams { protocolVersion: '2.1.0' | '2.2.0'; threeDSInfo: 'ChallengeResponse'; cres: string; } /** 3D Secure input parameters */ export type ThreeDSInputParams = ThreeDSPreAuthInputParams | ThreeDSv1AuthDataInputParams | ThreeDSv2AuthDataInputParams | ThreeDSv1ChallengeResponseInputParams | ThreeDSv2ChallengeResponseInputParams; export type ThreeDSRedirectInputParams = Omit<BaseThreeDSAuthenticationDataParams, 'protocolVersion' | 'threeDSInfo' | 'notificationURL' | 'threeDSCompInd' | 'threeDSServerTransID' | 'browserColorDepth' | 'browserJavaEnabled' | 'browserLanguage' | 'browserScreenHeight' | 'browserScreenWidth' | 'browserTZ' | 'browserJavascriptEnabled' | 'browserUserAgent' | 'browserAcceptHeader' | 'browserIP'>; export interface ThreeDSv1PreAuthOutputParams { protocolVersion: 'NO_3DS_v2'; threeDSInfo: 'CardConfiguration'; } export interface ThreeDSv2PreAuthWithoutMethodOutputParams { protocolVersion: '2.1.0' | '2.2.0'; threeDSInfo: 'CardConfiguration'; threeDSServerTransID: string; } export interface ThreeDSv2PreAuthWithMethodOutputParams extends ThreeDSv2PreAuthWithoutMethodOutputParams { threeDSMethodURL: string; } export type ThreeDSv2PreAuthOutputParams = ThreeDSv2PreAuthWithoutMethodOutputParams | ThreeDSv2PreAuthWithMethodOutputParams; export interface ThreeDSv1ChallengeOutputParams { protocolVersion: '1.0.2'; threeDSInfo: 'ChallengeRequest'; acsURL: string; MD: string; PAReq: string; } export interface ThreeDSv2ChallengeOutputParams { protocolVersion: '2.1.0' | '2.2.0'; threeDSInfo: 'ChallengeRequest'; acsURL: string; creq: string; } /** * 3D Secure output parameters */ export type ThreeDSOutputParams = ThreeDSv1PreAuthOutputParams | ThreeDSv2PreAuthOutputParams | ThreeDSv1ChallengeOutputParams | ThreeDSv2ChallengeOutputParams; /** * 3D Secure v2 challenge solution parameters */ export interface ThreeDSv2ChallengeSolutionNotificationOutputParams { cres: string; } /** * 3D Secure v1 challenge solution parameters */ export interface ThreeDSv1ChallengeSolutionNotificationOutputParams { MD: string; PaRes: string; } /** * 3DS v2 method data * * @public */ export interface ThreeDSMethodData { threeDSServerTransID: string; threeDSMethodNotificationURL: string; } /** * 3DS v2 method form * * @public */ export interface ThreeDSMethodForm { url: string; body: { threeDSMethodData: string; }; } /** * 3DS v1 challenge form * * @public */ export interface ThreeDSv1ChallengeForm { url: string; body: { /** Payment authentication Request, XML that is gzip compressed and base64 encoded */ PaReq: string; /** Merchant data, random generated identifier hex encoded? */ MD: string; /** Post challenge redirect URL */ TermUrl: string; }; } /** * 3DS v2 challenge form * * @public */ export interface ThreeDSv2ChallengeForm { url: string; body: { /** Challenge request, JSON that is base64 encoded */ creq: string; }; } /** * Contents of the `cres` field of a 3DS v2 challenge * * @public */ export interface ThreeDSCres { messageVersion: '2.1.0' | '2.2.0'; threeDSServerTransID: string; acsTransID: string; messageType: 'CRes'; transStatus: 'Y' | 'N'; }