Request Parameter

Description

MasterPassAction

Mandatory, the action to perform.

MasterPassMerchantID

Mandatory, the merchant id as captured on MasterPass.

MasterPassCode

Mandatory, the result code that must be queried

Amount

Mandatory, to use a variable amount use 0 as the amount.

Currency

Mandatory, the currency is tied to the merchant setup.

MerchantReference

Mandatory, used to link code to transaction.

MasterPassShortDescription

Mandatory, This will be displayed to the consumer at the time a code is scanned. Length is 5 to 45 characters

MasterPassCodeExpiryDate

Optional. If this is empty the code will by default expire in 30 minutes from issue. If this value is 0 the code will never expire. This time is specified in epoch.

Response Parameter

Description

MasterPassAction

The action that was performed

Request

Response

{

    "Version": "2.0",

    "CertificateID": "{xxxxxxxx-71dd-4044-802d-xxxxxxxxxxxx}",

    "ProductType": "Enterprise",

    "Direction": "Request",

    "Enquiry": {

      "ApplicationID": "{xxxxxxxx-68e0-42eb-aba9-xxxxxxxxxxxx}",

      "Mode": "Live",

      "command":"MasterPassQuickResponseCode",

      "MasterPassMerchantID": "xxxxx",

      "MasterPassAction": "UpdateCodeAmount",

      "MerchantReference": "Ref_001",

      "MasterPassCode":"xxx2720xxx",

      "Amount":"2000",

      "Currency":"ZAR",

      "MasterPassShortDescription":"The code has been updated"

   }

}

{

    "Version": "2.0",

    "Direction": "Response",

    "Enquiry": {

        "MasterPassAction": "UpdateCodeAmount",

        "ApplicationID": "{xxxxxxxx-68E0-42EB-ABA9-xxxxxxxxxxxx}",

        "Command": "MasterPassQuickResponseCode",

        "Mode": "Live",

        "RequestID": "{xxxxxxxx-5FAE-490C-87CF-xxxxxxxxxxxx}",

        "Result": {

            "Status": "0",

            "Code": "0",

            "Description": "",

            "AppServer": "QAGW2012APP1",

            "DBServer": "QAGW2012DB2",

            "Gateway": "QA"

        }

    }

}

Request

Response

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

  <Execute xmlns="http://iveri.com/">

  <validateRequest>false</validateRequest>

  <protocol>V_XML</protocol>

  <protocolVersion>7.0</protocolVersion>

  <request>&lt;V_XML Version="2.0" CertificateID="xxxxxxxx-71dd-4044-802d-xxxxxxxxxxxx" ProductType="Enterprise"

ProductVersion="iVeriWebService" Direction="Request"&gt;

&lt;Enquiry ApplicationID="xxxxxxxx-68e0-42eb-aba9-xxxxxxxxxxxx" Command="MasterPassQuickResponseCode" Mode="LIVE"&gt;

&lt;Amount&gt;2000&lt;/Amount&gt;

&lt;Currency&gt;ZAR&lt;/Currency&gt;

&lt;MerchantReference&gt;Ref_002&lt;/MerchantReference&gt;

&lt;MasterPassMerchantID&gt;xxxxx&lt;/MasterPassMerchantID&gt;

&lt;MasterPassAction&gt;UpdateCodeAmount&lt;/MasterPassAction&gt;

&lt;MasterPassCode&gt;xxx5104xxx&lt;/MasterPassCode&gt;

&lt;MasterPassShortDescription&gt;The code has been updated&lt;/MasterPassShortDescription&gt;

&lt;/Enquiry&gt;

&lt;/V_XML&gt;

</request>

  </Execute>

  </soap:Body>

  </soap:Envelope>

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><ExecuteResponse xmlns="http://iveri.com/"><ExecuteResult>&lt;V_XML Version="2.0" Direction="Response"&gt; &lt;Enquiry ApplicationID="{xxxxxxxx-68E0-42EB-ABA9-xxxxxxxxxxxx}" Command="MasterPassQuickResponseCode" Mode="Live" RequestID="{xxxxxxxx-E3FB-447B-BBC1-xxxxxxxxxxxx}"&gt; &lt;Result Status="0" Code="0" Description="" AppServer="QAGW2012APP1" DBServer="QAGW2012DB2" Gateway="QA" /&gt; &lt;MasterPassAction&gt;UpdateCodeAmount&lt;/MasterPassAction&gt; &lt;/Enquiry&gt; &lt;/V_XML&gt;</ExecuteResult></ExecuteResponse></soap:Body></soap:Envelope>