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

Additional Functions

The MWPayframe and tdsCheck object also have some additional functions that can assist with your implementation.

MWPayframe#

FunctionDescription
mwCardTypeUpdatedThis is a callback function that is called whenever the card number field is updated. It returns the cardType, cardBin, and whether the card is valid (in that order) as parameters of the function.
resetThis function is used to reset the payframe in order to process a second transaction. After processing your first transaction, you won't be able to submit the payframe again unless it is reset.
refreshThis function is used to refresh the styling of the payframe. If the payframe loads incorrectly or incompletely, you can use this function to reapply the styling.
loadingThis is a callback function that is called when the payframe begins loading, after being deployed. You can use this to trigger a loading animation or effect if you wish.
loadedThis is a callback function that is called when the payframe has finished loading. You can use this to disable any loading animations you may have started.
disableThis function is used to disable the payframe object to stop it listening to messages from the payframe iframe. Use this function before instantiating a new payframe, so that messages will be sent to the new payframe instead of the old payframe.

tdsCheck#

FunctionDescription
destroyThis function is used to close the 3DS verification window after verification has completed
loadingThis is a callback function that is called when the 3DS verification window begins loading. You can use this to trigger a loading animation or effect if you wish.
loadedThis is a callback function that is called when the 3DS verification window has finished loading. You can use this to disable any loading animations you may have started.
linkThis function is used to link the tdsCheck to an already-created mwPayframe. If you have written loading and loaded functions for the mwPayframe, this function will make the tdsCheck use the same functions, so you don't have to write them again.
Modified at 2026-07-17 02:43:46
Previous
tdsCheck
Next
Styling
Built with