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

Constructor

Required Parameters#

ParameterRequiredDescription
accessTokenThe accessToken obtained from the getAccessToken API method
Example: 2783a265a0
payframeDivIDYesThis is the id of the div you wish the payframe to appear in.
Example: cardData
srcYesThis is the Merchant Warrior url that the payframe will be loaded from.
Example: https://secure.merchantwarrior.com/payframe/
submitUrlYesThis parameter is used to set the target environment (Production, Camp).
Example: Production

Optional Parameters#

ParameterRequiredDescription
styleNoThis parameter is used to set custom styling for the payframe.
Example: {backgroundColor: 'Cyan', fontFamily: 'Times New Roman', payframeHeightScaling: 'dynamic'}
acceptedCardTypesNoThis parameter is a comma delimited list of card types that will be accepted (visa,mastercard,amex,diners,discover,jcb). If not set only Visa and Mastercard will be accepted.
Example: Visa, Mastercard, Diners
methodNoThis parameter is used to set the action to be performed by the payframe (addCard, getPayframeToken). By default, or if not set, the payframe will return a Payframe Token for use with a Process Card transaction.
Example: getPayframeToken
paymentFingerprintNoSet to true to receive a payment fingerprint in the response. A payment fingerprint remains unique for each card number and remains constant even if other card details, such as expiry date or cardholder name, are modified.

Sample getPayframeToken Implementation#

Sample addCard Implementation#

Modified at 2026-07-17 02:43:46
Previous
Usage
Next
tdsCheck
Built with