Query Code


Query Code

 Function: Query a code that has been created. 

Query 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 queried 


Response Parameter 

Description 

MasterPassAction 

The action that was performed 

MasterPassShortDescription 

Short decription linked to the code 

MasterPassCodeExpiryDate 

Date until the code is valid. This is in epoch time. 

MasterPassMerchantName 

The name of the merchant as captured on MasterPass 

Amount 

Amount linked to the code. 

Currency 

The currency is tied to the merchant setup. 

MerchantReference 

Linked to the code. 


Query Code – REST Sample

 

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": "QueryCode", 

      "MerchantReference": "Ref_001", 

      "MasterPassCode":"xxx2720xxx" 

   } 

} 

 

{ 

    "Version": "2.0", 

    "Direction": "Response", 

    "Enquiry": { 

        "Currency": "R", 

        "MerchantReference": "Ref_001", 

        "Amount": "1075", 

        "MasterPassAction": "QueryCode", 

        "MasterPassShortDescription": "Basket of goods", 

        "MasterPassCodeExpiryDate": "1645187074000", 

        "MasterPassMerchantName": "Retail Merchant 001", 

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

        "Command": "MasterPassQuickResponseCode", 

        "Mode": "Live", 

        "RequestID": "{xxxxxxxx-2207-4C11-A89C-xxxxxxxxxxxx}", 

        "Result": { 

            "Status": "0", 

            "Code": "0", 

            "Description": "", 

            "AppServer": "QAGW2012APP1", 

            "DBServer": "QAGW2012DB2", 

            "Gateway": "QA" 

        } 

    } 

} 

 


Query Code –SOAP Sample

Request  

Response 

<soap:Envelopexmlns: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> 

  <Executexmlns="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;QueryCode&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="{xxxxxxxx-55EC-4835-9817-xxxxxxxxxxxx}"&gt; &lt;Result Status="0" Code="0" Description="" AppServer="QAGW2012APP1" DBServer="QAGW2012DB2" Gateway="QA" /&gt; &lt;Currency&gt;R&lt;/Currency&gt; &lt;MerchantReference&gt;Ref_002&lt;/MerchantReference&gt; &lt;Amount&gt;1075&lt;/Amount&gt; &lt;MasterPassAction&gt;QueryCode&lt;/MasterPassAction&gt; &lt;MasterPassShortDescription&gt;TestProduct&lt;/MasterPassShortDescription&gt; &lt;MasterPassCodeExpiryDate&gt;1647898033000&lt;/MasterPassCodeExpiryDate&gt; &lt;MasterPassMerchantName&gt;Sample Merchant Enterprise Enterprise&lt;/MasterPassMerchantName&gt; &lt;/Enquiry&gt; 

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