1. Payframe
Merchant Warrior API 2.0
  • API
    • Getting Started
    • Guides
      • Xero Connection
      • Xero Custom URL
      • wooCommerce PayID
      • Middleware
      • Hostaway
    • Direct API
      • getAccessToken
      • processCard
      • processAuth
      • processCapture
      • processBatch
      • retrieveBatch (CSV)
      • retrieveBatch (JSON Response)
      • retrieveBatch (JSON Notify)
      • refundCard
      • queryCard
      • processDDebit
      • processDDebitAuth
      • processVoid
      • verifyCard
      • queryDD
      • queryBIN
      • getSettlement
      • checkEnrollment
      • checkPARes
      • addBlacklistedCard
      • removeBlacklistedCard
      • queryBlacklistedCard
      • simulateNotify
      • getSurcharge
    • 3DS 2.0
      • Introduction
      • 3DS 2 Authentication Flows
      • Step 3 - 3DS Method Data
      • Step 5 - Challenge
      • Step 1 - getAccessToken
      • Step 2 - checkEnrollment
      • Step 4 - checkTDSAuth
      • Step 6 - checkPARes
      • Step 7 - processCard
      • Authorization Only processCard
    • PayLink
      • Introduction
      • Generate PayLink
    • PayID
      • Introduction
      • Create
      • Transaction
      • Get
      • Update
      • Status
      • List
      • Refund
    • PayTo
      • Introduction
      • Simulator
      • Certification
      • Actions and Statuses
      • Agreements
        • Agreements
        • Notifications
        • Create Agreement
        • Get Agreement
        • Amend Agreement
        • Amend Agreement Status
        • Recall Agreement Action
      • Payments
        • Payments
        • Notifications
        • Create Payment
        • Get Payment
        • Get Payment Status
        • Search Payments
    • Confirmation of Payee
      • Introduction
      • Sandbox Simulations
      • Validate
    • POS
      • Introduction
      • processPOS
      • refundPOS
      • voidPOS
      • deregisterPOS
    • Web SDK
      • Introduction
      • Usage
      • getAccessToken
      • Options
      • Initiate
      • Payframe Functionality
      • Middleware
      • addCard
    • Payframe
      • Introduction
      • Usage
      • Constructor
      • tdsCheck
      • Additional Functions
      • Styling
      • processCard
        POST
      • processAuth
        POST
    • Digital Wallets
      • Apple Pay Prerequisites
      • Google Pay Prerequisites
      • Web SDK
      • Manual Integration
      • processCard
      • addCard
      • getMerchantSession
      • decryptApplePayToken
    • Token Payments
      • Introduction
      • Key Management
      • addCard
      • removeCard
      • cardInfo
      • changeExpiry
      • processCard
      • processAuth
    • Batch
      • Introduction
      • Card Batches
      • Token Batches
      • Direct Debit Batches
    • Forter
      • Introduction
      • Testing
    • Payouts
      • Introduction
      • Sandbox Simulations
      • Notifications
      • Create Payouts
      • Get Payout Status
      • Resend Notifications
      • Get Payout Transaction Status
      • Get Payout Transaction Notify
    • Partner API
      • Introduction
      • addMerchant
      • updateMerchant
      • checkMerchant
    • Notifications
      • Notifications
  • Hosted Payment Page
    • processCard
  1. Payframe

tdsCheck

Instantiate the tdsCheck object and set mwCallback (which is the callback function that will run after the 3DS check has completed). After the payframeToken and payframeKey are returned from the MW Payframe, call the checkTDS function. The tdsCheck object will communicate with the customer's bank and may perform a two-factor verification on the customer's card. In the event that the customer's bank opts for a two-factor verification, the verification window will be displayed in the tdsDivID that was configured in the tdsCheck object.
If the chosen div already contains an MW Payframe window, the tdsCheck object will close the MW Payframe window and replace it with the verification window. To show the MW Payframe again, you need to close the verification window with the destroy function below, then re-deploy the payframe.
After the 3DS verification has completed, the tdsCheck object will call mwCallback and return a boolean (indicating whether the 3DS verification resulted in a liability shift or not) and a threeDSToken. These values will also be set as properties of the tdsCheck object (liabilityShifted and mwTDSToken, respectively). The threeDSToken can be submitted with a processCard or processAuth request and should be submitted if you want 3DS protection for a transaction.
3DS chargeback protection will only be valid if the threeDSToken submitted has a liabilityShifted value of true and the threeDSToken is submitted with the processCard or processAuth request

tdsCheck Properties#

PropertyDescription
liabilityShiftedA boolean that identifies if the customer authentication has completed and whether liability has shifted to the issuer.
Example: true
mwTDSTokenThis property is used to indicate if a transaction has been authenticated.
Example: 8e86aef68037e8849980
mwTDSMessageThis property contains the status of the 3DS verification check.
Example: 3DS Successful
mwTDSEnrolledThis property is used to indicate if the customer's card is enrolled in 3DS.
Example: Y

Style Parameters#

This is a list of the parameters that can be sent with the style option in the tdsCheck object constructor. The tdsCheck object will use the default values listed if a parameter is not set.
ParameterDefaultDescription
width500pxThe width of the 3DS verification window
Example: width: '800px'
height500pxThe height of the 3DS verification window
Example: height: '350px'
The tdsCheck object also has some Additional Functions that can assist with your implementation.

checkTDS Parameters#

All of these parameters are required
ParameterRequiredDescription
payframeTokenYesA unique alphanumeric string returned by an MW Payframe that uses the getPayframeToken method.
Example: KMJI24557546102398
payframeKeyYesA unique alphanumeric string returned by an MW Payframe that uses the getPayframeToken method.
Example: b941071d7be8d11f4c8e6c038968bc0d
transactionAmountYesThe amount must be formatted to have two decimal places. Any amounts without two decimal places or amounts less than one cent will be rejected.
Example: 10.00
transactionCurrencyYesOne of the following: AUD, CAD, EUR, GBP, JPY, NZD, SGD, USD, FJD, HKD, MYR, THB, IDR, ZAR. This is provider dependent. Please check with MW before attempting to process transactions in any currency other than AUD. This field is case insensitive.
Example: AUD
transactionProductYesA product (or sale) id or description. We recommend using an order/product id. This field's primary purpose is to help the transaction be identifiable for reporting and accounting purposes.
Example: ABC4321

Constructor Parameters#

ParameterRequiredDescription
merchantUUIDYesThe value of this parameter is provided to you by Merchant Warrior.
Example: 123456789abcd
apiKeyYesThe value of this parameter is provided to you by Merchant Warrior.
Example: 1a3b5c
tdsDivIDYesThis is the id of the div you wish the 3DS verification window to appear in.
Example: tdsCheck
submitUrlYesThis parameter is used to set the target environment (Production, Camp).
Example: Production
styleNoThis parameter is used to set style options for the 3DS verification window.
Example: {width: '500px'}

Sample Implementation#

Modified at 2026-07-17 02:43:46
Previous
Constructor
Next
Additional Functions
Built with