Create Code


Create Code

 
Function: Generate a transactional code that can then be paid for by a cardholder. This code can be represented as a QR code, transferred using NFC or manually entered a device. The code can also be used as part of an In-App payment.

Create Code Parameters

Request Parameter

Description

MasterPassAction

Mandatory, The action to perform.

MasterPassMerchantID

Mandatory, The merchant id as captured on MasterPass.

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.

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.

Response Parameter

Description

MasterPassAction

The action that was performed

MasterPassCode

This is the result code

MasterPassCodeExpiryDate

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

Create Code – REST Sample

 

Request

Response

Request:

{

    "Version""2.0",

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

    "ProductType""Enterprise",

    "Direction""Request",

    "Enquiry": {

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

      "Command""MasterPassQuickResponseCode",

      "Mode""Live",

      "MasterPassMerchantID""xxxxx",

      "MasterPassAction""CreateCode",

      "Currency""ZAR",

      "MerchantReference""Ref_001",

      "Amount""1075",

      "MasterPassShortDescription""Basket of goods"

   }

}

 

{

    "Version""2.0",

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

    "ProductType""Enterprise",

    "Direction""Request",

    "Enquiry": {

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

      "Command""MasterPassQuickResponseCode",

      "Mode""Live",

      "MasterPassMerchantID""xxxxx",

      "MasterPassAction""CreateCode",

      "Currency""ZAR",

      "MerchantReference""Ref_001",

      "Amount""1075",

      "MasterPassShortDescription""Basket of goods"

   }

}

 

Create Code – SOAP Sample

SOAP Request

SOAP 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;1075&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;CreateCode&lt;/MasterPassAction&gt;

&lt;MasterPassShortDescription&gt;TestProduct1&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-DBC4-484A-84C1-xxxxxxxxxxxx}"&gt;
    &lt;Result Status="0" Code="0" Description="" AppServer="QAGW2012APP1" DBServer="QAGW2012DB2" Gateway="QA" /&gt;
    &lt;MasterPassAction&gt;CreateCode&lt;/MasterPassAction&gt;
    &lt;MasterPassCodeExpiryDate&gt;1647807283989&lt;/MasterPassCodeExpiryDate&gt;
    &lt;MasterPassCode&gt;xxx6944xxx&lt;/MasterPassCode&gt;
  &lt;/Enquiry&gt;
&lt;/V_XML&gt;</ExecuteResult></ExecuteResponse></soap:Body></soap:Envelope>