Block Code

 
Function: This is an API call to temporarily block a code. This prevents purchases on the code.

Block Code Parameters

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 blocked

Response Parameter

Description

MasterPassAction

The action that was performed


Block Code Sample Message

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""BlockCode",

      "MerchantReference""Ref_001",

      "MasterPassCode":"xxx2720xxx"

   }

}

 

{

    "Version""2.0",

    "Direction""Response",

    "Enquiry": {

        "MasterPassAction""BlockCode",

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

        "Command""MasterPassQuickResponseCode",

        "Mode""Live",

        "RequestID""{xxxxxxxx-7EF2-449D-8454-xxxxxxxxxxxx}",

        "Result": {

            "Status""0",

            "Code""0",

            "Description""",

            "AppServer""QAGW2012APP1",

            "DBServer""QAGW2012DB2",

            "Gateway""QA"

        }

    }

}

 


Block Code – SOAP Sample

 

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;MerchantReference&gt;Ref_002&lt;/MerchantReference&gt;

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

&lt;MasterPassAction&gt;BlockCode&lt;/MasterPassAction&gt;

&lt;MasterPassCode&gt;xxx5104xxx&lt;/MasterPassCode&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="{xxxxxxx-271A-407D-AB52-xxxxxxxxxxxx}"&gt;

    &lt;Result Status="0" Code="0" Description="" AppServer="QAGW2012APP1" DBServer="QAGW2012DB2" Gateway="QA" /&gt;

  &lt;MasterPassAction&gt;BlockCode&lt;/MasterPassAction&gt;

  &lt;/Enquiry&gt;

&lt;/V_XML&gt;</ExecuteResult></ExecuteResponse></soap:Body></soap:Envelope>