Options

The Web SDK has a number of options that can be used with your implementation. These options should be inserted into a <script> section on your page.

The options available are listed below.

Properties

Property	Description
customer	Type: Object
customer.name	Name of the customer Type: String
customer.country	Country of the customer Type: String
customer.state	State of the customer Type: String
customer.city	City of the customer Type: String
customer.address	Street address of the customer Type: String
customer.postCode	Postcode of the customer Type: String
customer.phone	Phone number of the customer Type: String
customer.email	Email of the customer Type: String
summary	Type: Object
summary.total	Type: Object
summary.total.amount	Total amount of the transaction, formatted with 2 decimal places for cents. Type: String
summary.total.label	????????? Type: String
summary.customer	Type: Object
summary.addCard	Indicates if the payment method used should be tokenised. If true, a cardID will be returned. Type: Boolean
summary.recurring	Indicates if the payment is a recurring payment. Type: Boolean
summary.style	Type: String
summary.googlePay	Type: Object
summary.googlePay.allowedAuthMethods	The GP authentication method you wish to use. Can be one or both of the following - * PAN_ONLY * CRYPTOGRAM_3DS Type: Array of strings
summary.googlePay.buttonHeight	Height, in pixels, of the Google Pay button. Type: String
summary.googlePay.buttonWidth	Width, in pixels, of the Google Pay button. Type: String
summary.googlePay.marginTop	Top margin, in pixels, of the Google Pay button. Type: String
summary.googlePay.marginBottom	Bottom margin, in pixels, of the Google Pay button. Type: String
summary.googlepay.allowedCardNetworks	Optional array specifying which card types are allowed. If not specified, all cards will be allowed. Possible values include - visa mastercard amex Type: Array of strings
summary.googlepay.threeDS	Indicates whether 3DS should be performed on the Google Pay transaction. This feature will detect if liability shift occurred, and if not, perform a separate 3DS process. Type: String
summary.googlepay.allowCreditCards	Indicates whether Credit Cards will be allowed. Type: Boolean Default: true
summary.googlepay.allowPrepaidCards	Indicates whether Prepaid Cards will be allowed. Type: Boolean Default: true
summary.applePay	Type: Object
summary.applePay.buttonHeight	Height, in pixels, of the Apple Pay button. Type: String
summary.applePay.buttonWidth	Width, in pixels, of the Apple Pay button. Type: String
summary.applePay.marginTop	Top margin, in pixels, of the Apple Pay button. Type: String
summary.applePay.marginBottom	Bottom margin, in pixels, of the Apple Pay button. Type: String
summary.applepay.allowedCardNetworks	Optional array specifying which card types are allowed. If not specified, all cards will be allowed. Possible values include - visa mastercard amex Type: Array of strings
summary.applepay.merchantCapabilities	Defines the payment capabilities the merchant supports. Acceptable values include: "supports3DS" (Required) "supportsEMV" (Include only if China Union Pay transactions are supported) "supportsCredit" (Optional, for credit card transactions) "supportsDebit" (Optional, for debit card transactions)
Type: Array of strings
wallets	An array of values indicating what wallets you wish to use. The following values are valid - * googlepay * applepay * basic-card Type: Array of strings
payframe	Type: Object
payframe.threeDS	Indicates if you wish to enable 3DS for payments through the Payframe. Type: Boolean
payframe.submitUrl	The URL the Payframe should submit to. One of the following values should be used - * Sandbox: https://base.merchantwarrior.com/payframe/ * Production: https://api.merchantwarrior.com/payframe/ Type: String
payframe.styles	An object of CSS styles to apply to the Payframe. Possible options are shown here. Type: Object
payframe.tdsStyles	An object of CSS styles to apply to the 3DS iFrame. Possible options are shown here. Type: Object
options	Type: Object
options.environment	Indicates which environment to use. One of the following values - * development * production Type: String
options.autoProcess	Indicates if the token should be used to process the transaction as soon as it is obtained. Type: Boolean
options.middleware	URL or Javascript promise to use as your middleware. Must be specified if autoProcess is set to false. More details below. Type: String
transaction	Type: Object
transaction.transactionProduct	A 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. Type: String
transaction.transactionReferenceID	This is a merchant’s unique reference ID for a transaction sent to Merchant Warrior. The main purpose of this ID is to verify the transaction via the queryCard method in the event a valid response is not received. Type: String
transaction.storeID	The value of this field is the merchant's store name. Please note that you need to contact Merchant Warrior to enable the storeID feature before you can use this parameter. Type: String
transaction.custom1	Freeform field. Returned as `<custom1>` in the response. Type: String
transaction.custom2	Freeform field. Returned as `<custom2>` in the response. Type: String
transaction.custom3	Freeform field. Returned as `<custom3>` in the response. Type: String
transaction.currency	One of the following: AUD, CAD, EUR, GBP, JPY, NZD, SGD, USD. This is provider dependant. Please check with MW before attempting to process transactions in any currency other than AUD. This field is case insensitive. Type: String

Properties#

JSON#

Properties

JSON