Payment methods

VISA CheckOut 


Visa Check-Out is a digital representation of a cardholders Visa Card. Cardholders can register their debit or credit cards by downloading the Visa Check-Out app. Once cardholders have their profiles and card details loaded in Visa Check-out, they are able to make purchases at merchants who are accepting Visa Check-Out payments.


Illustration of Visa Check Out with Enterprise


Process Flow in Visa Check-Out with enterprise


  1. Cardholder selects Visa Check-Out as payment method
  2. Enterprise Merchant calls Visa Light Box or Widget and presents it to the Cardholder to Login
  3. Cardholder Logins via Visa Light Box   
  4. Cardholder selects a card and presses Continue
  5. Upon clicking Continue, Enterprise Merchant sends the Call ID to the iVeri gateway
  6. The iVeri gateway uses the Call ID to get the Payload from Visa services
  7. Payload is returned by Visa services to the iVeri gateway
  8. The iVeri gateway decrypts the Payload and retrieves the PAN
  9. The iVeri gateway sends the transaction request to the acquire for processing
  10. When a response is received, the iVeri gateway sends the transaction response to the enterprise merchant
  11. Lastly, the enterprise merchant updates Visa services with a failed or successful transaction response.


Note:

This functionality is not available by default, it is specific to an acquirer.

The process flow described below only show cases the interaction between cardholder, enterprise merchant, the gateway and Visa service


Foreign Exchange

 

Dynamic Currency Conversion (DCC)

DCC is service that enables payment card cardholders to make international card purchases or transactions in their own currency. The conversion of the purchase price of goods or services from the merchant’s local currency to the cardholder’s home currency occurs at the point of sale at the quoted exchange rate from a cited exchange rate source.


DCC Transaction Flow

  • Perform an enquiry DCC rate request using a PAN and Amount to the iVeri Gateway 
  • Merchant presents the returned DCC rate offer to the customer
  • Perform a transaction using the customers elected currency 

DCC Messages

REST

Request

{

    "Version": "2.0",

    "CertificateID": "{4c96973f-71dd-4044-802d-6e234effe8f2}",

    "ProductType": "Enterprise",

    "ProductVersion": "WebAPI",

    "Direction": "Request",

    "Enquiry": {

        "ApplicationID": "{56cdf444-b238-4609-9137-148a34b08f59}",

        "Command": "DynamicCurrencyConversion",

        "Mode": "LIVE",

        "MerchantReference": "Farm_1709",

        "MerchantTrace": "20220520_1706",

        "Currency": "ZAR",

        "Amount": "5000",

        "ExpiryDate": "1225",

        "CardSecurityCode": "001",

        "PAN": "5185520050000010"

    }


 

Response  

{

    "Version": "2.0",

    "Direction": "Response",

    "Enquiry": {

        "MerchantName": "Busiswa",

        "MerchantUSN": "1732460",

        "Acquirer": "NBPostilionNBSouthAfrica",

        "AcquirerReference": "02848:09021748",

        "AcquirerDate": "20221230",

        "AcquirerTime": "151154",

        "Currency": "ZAR",

        "Amount": "5000",

        "MerchantAddress": "MERCHANT ADDRESS",

        "MerchantCity": "Sandton",

        "MerchantCountryCode": "ZA",

        "MerchantCountry": "South Africa",

        "DistributorName": "Nedbank",

        "ForeignExchange": {

            "ForeignExchangeItem": [

                {

                    "Version": "1.0",

                    "ForeignExchangeID": "{3056511A-360E-4C57-8437-4BEBE5CF0CD4}",

                    "ForeignExchangeProvider": "Fexco",

                    "BaseCurrency": "ZAR",

                    "BaseAmount": "50.00",

                    "ForeignCurrency": "KES",

                    "ForeignAmount": "405.29",

                    "ExchangeRate": "8.1058",

                    "ExpiryDateTime": "2023-12-30 15:10:21",

                    "MarginPercentage": "3.5",

                    "CommissionPercentage": "0.000000",

                    "Source": "REUTERS WHOLESALE INTERBANK",

                    "SourceTimestamp": "2022-03-29 17:31:06"

                }

            ]

        },

        "ApplicationID": "{56CDF444-B238-4609-9137-148A34B08F59}",

        "Command": "DynamicCurrencyConversion",

        "Mode": "Live",

        "RequestID": "{E575AA65-8C06-4814-B9CC-A99AD4C06EB1}",

        "Result": {

            "Status": "0",

            "Code": "0",

            "Description": "",

            "AppServer": "QA2019GWAPP01",

            "DBServer": "QA2019GWDB02",

            "Gateway": "QA",

            "AcquirerCode": "00",

            "AcquirerDescription": ""

        }

    }

}

 SOAP

Request 

<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="{4c96973f-71dd-4044-802d-6e234effe8f2}" 

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

    &lt;Enquiry ApplicationID="{56cdf444-b238-4609-9137-148a34b08f59}" Command="DynamicCurrencyConversion" Mode="Live"&gt;

    &lt;MerchantTrace&gt;240X568VFEEE&lt;/MerchantTrace&gt;

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

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

    &lt;ExpiryDate&gt;1225&lt;/ExpiryDate&gt;

    &lt;MerchantReference&gt;20220104.1525&lt;/MerchantReference&gt;

    &lt;CardSecurityCode&gt;001&lt;/CardSecurityCode&gt;

    &lt;PAN&gt;5185520050000010&lt;/PAN&gt;

    &lt;/Enquiry&gt;&lt;/V_XML&gt;

</request>

  </Execute>

  </soap:Body>

  </soap:Envelope>

 

 

Response  

<?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="{56CDF444-B238-4609-9137-148A34B08F59}" Command="DynamicCurrencyConversion" Mode="Live" RequestID="{0192B92C-E645-4E67-877D-4EEB71492818}"&gt;

    &lt;Result Status="0" Code="0" Description="" AppServer="QA2019GWAPP01" DBServer="QA2019GWDB02" Gateway="QA" AcquirerCode="00" AcquirerDescription="" /&gt;

    &lt;MerchantName&gt;Busiswa&lt;/MerchantName&gt;

    &lt;MerchantUSN&gt;1732460&lt;/MerchantUSN&gt;

    &lt;Acquirer&gt;NBPostilionNBSouthAfrica&lt;/Acquirer&gt;

    &lt;AcquirerReference&gt;02848:09021749&lt;/AcquirerReference&gt;

    &lt;AcquirerDate&gt;20221230&lt;/AcquirerDate&gt;

    &lt;AcquirerTime&gt;153200&lt;/AcquirerTime&gt;

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

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

    &lt;MerchantAddress&gt;MERCHANT ADDRESS&lt;/MerchantAddress&gt;

    &lt;MerchantCity&gt;Sandton&lt;/MerchantCity&gt;

    &lt;MerchantCountryCode&gt;ZA&lt;/MerchantCountryCode&gt;

    &lt;MerchantCountry&gt;South Africa&lt;/MerchantCountry&gt;

    &lt;DistributorName&gt;Nedbank&lt;/DistributorName&gt;

    &lt;ForeignExchange&gt;

      &lt;ForeignExchangeItem Version="1.0"&gt;

        &lt;ForeignExchangeID&gt;{62EC3B82-BD4A-40D0-9AB1-79996761A17E}&lt;/ForeignExchangeID&gt;

        &lt;ForeignExchangeProvider&gt;Fexco&lt;/ForeignExchangeProvider&gt;

        &lt;BaseCurrency&gt;ZAR&lt;/BaseCurrency&gt;

        &lt;BaseAmount&gt;20.00&lt;/BaseAmount&gt;

        &lt;ForeignCurrency&gt;KES&lt;/ForeignCurrency&gt;

        &lt;ForeignAmount&gt;162.12&lt;/ForeignAmount&gt;

        &lt;ExchangeRate&gt;8.1058&lt;/ExchangeRate&gt;

        &lt;ExpiryDateTime&gt;2023-12-30 15:30:27&lt;/ExpiryDateTime&gt;

        &lt;MarginPercentage&gt;3.5&lt;/MarginPercentage&gt;

        &lt;CommissionPercentage&gt;0.000000&lt;/CommissionPercentage&gt;

        &lt;Source&gt;REUTERS WHOLESALE INTERBANK&lt;/Source&gt;

        &lt;SourceTimestamp&gt;2022-03-29 17:31:06&lt;/SourceTimestamp&gt;

      &lt;/ForeignExchangeItem&gt;

    &lt;/ForeignExchange&gt;

  &lt;/Enquiry&gt;

&lt;/V_XML&gt;</ExecuteResult>

        </ExecuteResponse>

    </soap:Body>

</soap:Envelope>

 

 Perform a transaction using the customers elected currency

REST

Request

{

    "Version": "2.0",

    "CertificateID": "{4c96973f-71dd-4044-802d-6e234effe8f2}",

    "ProductType": "Enterprise",

    "ProductVersion": "WebAPI",

    "Direction": "Request",

    "Transaction": {

        "ApplicationID": "{56cdf444-b238-4609-9137-148a34b08f59}",

        "Command": "Debit",

        "Mode": "LIVE",

        "MerchantReference": "Farm_12098",

        "MerchantTrace": "20220520_1631",

        "Currency": "ZAR",

        "Amount": "5000",

        "ExpiryDate": "1225",

        "CardSecurityCode": "001",

        "PAN": "5185520050000010",

        "ForeignAmount": "40529",

        "ForeignCurrency": "KES",

        "ForeignExchangeID":"{3056511A-360E-4C57-8437-4BEBE5CF0CD4}"

 

    }

}

 

Response

{

    "Version": "2.0",

    "Direction": "Response",

    "Transaction": {

        "MerchantTrace": "20220520_1631",

        "Amount": "5000",

        "AuthorisationCode": "012247",

        "CCNumber": "5185........0010",

        "Currency": "ZAR",

        "ExpiryDate": "122025",

        "MerchantReference": "Farm_12098",

        "Terminal": "Default",

        "TransactionIndex": "{C4BF6D8A-E6DF-4B92-8B40-056CA516A5FE}",

        "MerchantName": "Busiswa",

        "MerchantUSN": "1732460",

        "Acquirer": "NBPostilionNBSouthAfrica",

        "AcquirerReference": "02848:09021750",

        "AcquirerDate": "20221230",

        "AcquirerTime": "155823",

        "DisplayAmount": "R 50.00",

        "BIN": "5",

        "Association": "MasterCard",

        "CardType": "Unknown Card Type",

        "Issuer": "Unknown Issuer",

        "Jurisdiction": "International",

        "PAN": "5185........0010",

        "PANMode": "Keyed",

        "ReconReference": "09021750",

        "CardHolderPresence": "CardNotPresent,MOTO",

        "MerchantAddress": "MERCHANT ADDRESS",

        "MerchantCity": "Sandton",

        "MerchantCountryCode": "ZA",

        "MerchantCountry": "South Africa",

        "DistributorName": "Nedbank",

        "ForeignAmount": "40529",

        "ForeignCurrency": "KES",

        "DisplayForeignAmount": "KSh 405.29",

        "ApplicationID": "{56CDF444-B238-4609-9137-148A34B08F59}",

        "Command": "Debit",

        "Mode": "Live",

        "RequestID": "{F9EE9359-9D62-46C3-AE4E-97E151A8EB6E}",

        "Result": {

            "Status": "0",

            "Code": "0",

            "Description": "",

            "AppServer": "QA2019GWAPP01",

            "DBServer": "QA2019GWDB02",

            "Gateway": "QA",

            "AcquirerCode": "00",

            "AcquirerDescription": ""

        }

    }

}

SOAP

Request

<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="{4c96973f-71dd-4044-802d-6e234effe8f2}" 

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

    &lt;Enquiry ApplicationID="{56cdf444-b238-4609-9137-148a34b08f59}" Command= Mode="Live"&gt;

    &lt;MerchantTrace&gt;240X568VFEEE&lt;/MerchantTrace&gt;

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

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

    &lt;ExpiryDate&gt;1225&lt;/ExpiryDate&gt;

    &lt;MerchantReference&gt;20220104.1525&lt;/MerchantReference&gt;

    &lt;CardSecurityCode&gt;001&lt;/CardSecurityCode&gt;

    &lt;PAN&gt;5185520050000010&lt;/PAN&gt;

    &lt;/Enquiry&gt;&lt;/V_XML&gt;

        &lt;ForeignExchangeID&gt;{62EC3B82-BD4A-40D0-9AB1-79996761A17E}&lt;/ForeignExchangeID&gt;

        &lt;ForeignCurrency&gt;KES&lt;/ForeignCurrency&gt;

        &lt;ForeignAmount&gt;16212&lt;/ForeignAmount&gt;

 

</request>

  </Execute>

  </soap:Body>

  </soap:Envelope>

Multi-Currency Pricing (MCP)

 

MCP offers eCommerce merchants the ability to sell their goods or services in currencies other than their base/local currency. This gives the merchant the ability to transact with new customers around the world while at the same time they can generate a new revenue stream. With MCP, the merchant prices goods/services in a currency other than, or in addition to, the merchant’s local currency.

The cardholder makes a purchase decision based on the price displayed by the merchant. The transaction is then completed with the price displayed by the merchant and the currency selected by the cardholder, with no currency conversion performed by the merchant.


MCP Transaction Flow

  • Perform an enquiry message using MCP enquiry message.
  • Merchant makes use of the returned list of MPC rates and perform transactions based on the customers elected currency. 


NB: Support of MCP is not yet publicly available to merchants.


MCP - SAMPLES

 REST

Request

{

    "Version": "2.0",

    "CertificateID": "{4c96973f-71dd-4044-802d-6e234effe8f2}",

    "ProductType": "Enterprise",

    "ProductVersion": "WebAPI",

    "Direction": "Request",

    "Enquiry": {

        "ApplicationID": "{56cdf444-b238-4609-9137-148a34b08f59}",

        "Command": " MultiCurrencyPricing ",

        "Mode": "LIVE",

        "MerchantReference": "Farm_1709",

        "MerchantTrace": "20220520_1706",

        "Currency": "ZAR",

        "Amount": "5000",

        "ExpiryDate": "1225",

        "CardSecurityCode": "001",

        "PAN": "5185520050000010"

    }

}

 

Response

{

    "Version": "2.0",

    "Direction": "Response",

    "Enquiry": {

        "MerchantName": "Busiswa",

        "MerchantUSN": "1732460",

        "Acquirer": "NBPostilionNBSouthAfrica",

        "AcquirerReference": "02848:09021748",

        "AcquirerDate": "20221230",

        "AcquirerTime": "151154",

        "Currency": "ZAR",

        "Amount": "5000",

        "MerchantAddress": "MERCHANT ADDRESS",

        "MerchantCity": "Sandton",

        "MerchantCountryCode": "ZA",

        "MerchantCountry": "South Africa",

        "DistributorName": "Nedbank",

        "ForeignExchange": {

            "ForeignExchangeItem": [

                {

                    "Version": "1.0",

                    "ForeignExchangeID": "{3056511A-360E-4C57-8437-4BEBE5CF0CD4}",

                    "ForeignExchangeProvider": "Fexco",

                    "BaseCurrency": "ZAR",

                    "BaseAmount": "50.00",

                    "ForeignCurrency": "KES",

                    "ForeignAmount": "405.29",

                    "ExchangeRate": "8.1058",

                    "ExpiryDateTime": "2023-12-30 15:10:21",

                    "MarginPercentage": "3.5",

                    "CommissionPercentage": "0.000000",

                    "Source": "REUTERS WHOLESALE INTERBANK",

                    "SourceTimestamp": "2022-03-29 17:31:06"

                }

            ]

        },

        "ApplicationID": "{56CDF444-B238-4609-9137-148A34B08F59}",

        "Command": "DynamicCurrencyConversion",

        "Mode": "Live",

        "RequestID": "{E575AA65-8C06-4814-B9CC-A99AD4C06EB1}",

        "Result": {

            "Status": "0",

            "Code": "0",

            "Description": "",

            "AppServer": "QA2019GWAPP01",

            "DBServer": "QA2019GWDB02",

            "Gateway": "QA",

            "AcquirerCode": "00",

            "AcquirerDescription": ""

        }

    }

}

SOAP

Request

<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="{4c96973f-71dd-4044-802d-6e234effe8f2}" 

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

    &lt;Enquiry ApplicationID="{56cdf444-b238-4609-9137-148a34b08f59}" Command=" MultiCurrencyPricing " Mode="Live"&gt;

    &lt;MerchantTrace&gt;240X568VFEEE&lt;/MerchantTrace&gt;

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

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

    &lt;ExpiryDate&gt;1225&lt;/ExpiryDate&gt;

    &lt;MerchantReference&gt;20220104.1525&lt;/MerchantReference&gt;

    &lt;CardSecurityCode&gt;001&lt;/CardSecurityCode&gt;

    &lt;PAN&gt;5185520050000010&lt;/PAN&gt;

    &lt;/Enquiry&gt;&lt;/V_XML&gt;

</request>

  </Execute>

  </soap:Body>

  </soap:Envelope>

 

Response 

<?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="{56CDF444-B238-4609-9137-148A34B08F59}" Command="DynamicCurrencyConversion" Mode="Live" RequestID="{0192B92C-E645-4E67-877D-4EEB71492818}"&gt;

    &lt;Result Status="0" Code="0" Description="" AppServer="QA2019GWAPP01" DBServer="QA2019GWDB02" Gateway="QA" AcquirerCode="00" AcquirerDescription="" /&gt;

    &lt;MerchantName&gt;Busiswa&lt;/MerchantName&gt;

    &lt;MerchantUSN&gt;1732460&lt;/MerchantUSN&gt;

    &lt;Acquirer&gt;NBPostilionNBSouthAfrica&lt;/Acquirer&gt;

    &lt;AcquirerReference&gt;02848:09021749&lt;/AcquirerReference&gt;

    &lt;AcquirerDate&gt;20221230&lt;/AcquirerDate&gt;

    &lt;AcquirerTime&gt;153200&lt;/AcquirerTime&gt;

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

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

    &lt;MerchantAddress&gt;MERCHANT ADDRESS&lt;/MerchantAddress&gt;

    &lt;MerchantCity&gt;Sandton&lt;/MerchantCity&gt;

    &lt;MerchantCountryCode&gt;ZA&lt;/MerchantCountryCode&gt;

    &lt;MerchantCountry&gt;South Africa&lt;/MerchantCountry&gt;

    &lt;DistributorName&gt;Nedbank&lt;/DistributorName&gt;

    &lt;ForeignExchange&gt;

      &lt;ForeignExchangeItem Version="1.0"&gt;

        &lt;ForeignExchangeID&gt;{62EC3B82-BD4A-40D0-9AB1-79996761A17E}&lt;/ForeignExchangeID&gt;

        &lt;ForeignExchangeProvider&gt;Fexco&lt;/ForeignExchangeProvider&gt;

        &lt;BaseCurrency&gt;ZAR&lt;/BaseCurrency&gt;

        &lt;BaseAmount&gt;20.00&lt;/BaseAmount&gt;

        &lt;ForeignCurrency&gt;KES&lt;/ForeignCurrency&gt;

        &lt;ForeignAmount&gt;162.12&lt;/ForeignAmount&gt;

        &lt;ExchangeRate&gt;8.1058&lt;/ExchangeRate&gt;

        &lt;ExpiryDateTime&gt;2023-12-30 15:30:27&lt;/ExpiryDateTime&gt;

        &lt;MarginPercentage&gt;3.5&lt;/MarginPercentage&gt;

        &lt;CommissionPercentage&gt;0.000000&lt;/CommissionPercentage&gt;

        &lt;Source&gt;REUTERS WHOLESALE INTERBANK&lt;/Source&gt;

        &lt;SourceTimestamp&gt;2022-03-29 17:31:06&lt;/SourceTimestamp&gt;

      &lt;/ForeignExchangeItem&gt;

    &lt;/ForeignExchange&gt;

  &lt;/Enquiry&gt;

&lt;/V_XML&gt;</ExecuteResult>

        </ExecuteResponse>

    </soap:Body>

</soap:Envelope>

MasterPass

MasterPass is a safe and easy way in which merchants can present the QR code which customers can scan using a MasterPass application to affect a payment.

 

Create Code

 Requirements


Merchant must be onboarded for MasterPass on the iVeri Gateway and on the MasterPass platform. 


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 

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

   } 

 

Response 

    "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 

Request

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

 

Response    

<?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>

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 

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

   } 

 

Response   

    "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  

<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;QueryCode&lt;/MasterPassAction&gt; 

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

&lt;/Enquiry&gt; 

&lt;/V_XML&gt; 

</request> 

  </Execute> 

  </soap:Body> 

  </soap:Envelope> 

 

Response 

<?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 

Delete Code

 Function: Delete a code that has been created 


Delete 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 deleted 

Response Parameter 

Description 

MasterPassAction 

The action that was performed 

Delete Code – REST Sample

Request 

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

      "MerchantReference": "Ref_001", 

      "MasterPassCode":"0790455080" 

   } 

 

Response

    "Version": "2.0", 

    "Direction": "Response", 

    "Enquiry": { 

        "MasterPassAction": "DeleteCode", 

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

        "Command": "MasterPassQuickResponseCode", 

        "Mode": "Live", 

        "RequestID": "{xxxxxxxx-1DC1-4D06-A632-xxxxxxxxxxxx}", 

        "Result": { 

            "Status": "0", 

            "Code": "0", 

            "Description": "", 

            "AppServer": "QAGW2012APP1", 

            "DBServer": "QAGW2012DB2", 

            "Gateway": "QA" 

        } 

    } 

 

Delete Code – SOAP  Sample

Request

<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="DeleteCode" Mode="LIVE"&gt; 

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

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

&lt;MasterPassAction&gt;DeleteCode&lt;/MasterPassAction&gt; 

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

&lt;/Enquiry&gt; 

&lt;/V_XML&gt; 

</request> 

  </Execute> 

 

Response 
<?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="DeletCode Mode="Live" RequestID="{xxxxxxxx-304D-4EB0-882D-xxxxxxxxxxxx}"&gt; &lt;Result Status="0" Code="0" Description="" AppServer="QAGW2012APP1" DBServer="QAGW2012DB2" Gateway="QA" /&gt; &lt;MasterPassAction&gt;DeleteCode&lt;/MasterPassAction&gt; &lt;/Enquiry&gt; &lt;/V_XML&gt;</ExecuteResult></ExecuteResponse></soap:Body></soap:Envelope> 

Update Code

Function: Query a code that has been created.


Update 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

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


Update Code - REST Sample

Request

{

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

 

   }

}

 

Response

{

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

        }

    }

}


Update Code -SOAP Sample

Request

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


Response
<?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:

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

{

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

   }

}


Response

{

    "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

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

 

Response

<?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>

 

Unblock Code

 

Function: This unblocks a blocked code. This call enables future purchases on that code.


Unblock 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 unblocked


Response Parameter

Description

MasterPassAction

The action that was performed


UnBlock Code – REST Sample 

Request

{

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

      "MerchantReference": "Ref_001",

      "MasterPassCode":"xxx2720xxx"

   }

}


Response

{

    "Version": "2.0",

    "Direction": "Response",

    "Enquiry": {

        "MasterPassAction": "UnblockCode",

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

        "Command": "MasterPassQuickResponseCode",

        "Mode": "Live",

        "RequestID": "{xxxxxxxx-6E28-41F2-81BE-xxxxxxxxxxxx}",

        "Result": {

            "Status": "0",

            "Code": "0",

            "Description": "",

            "AppServer": "QAGW2012APP1",

            "DBServer": "QAGW2012DB2",

            "Gateway": "QA"

        }

    }

}


UnBlock Code – SOAP Sample

Request

<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-xxxxxxxxxx" ProductType="Enterprise"

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

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

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

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

&lt;MasterPassAction&gt;UnblockCode&lt;/MasterPassAction&gt;

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

&lt;/Enquiry&gt;

&lt;/V_XML&gt;

</request>

  </Execute>

  </soap:Body>

  </soap:Envelope>


Response

<?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="{xxxxxxxxxx-68E0-42EB-ABA9-xxxxxxxxxxxx}" Command="MasterPassQuickResponseCode" Mode="Live" RequestID="{xxxxxxxxxx-474B-454E-801D-xxxxxxxxxxxx}"&gt;

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

    &lt;MasterPassAction&gt;UnblockCode&lt;/MasterPassAction&gt;

  &lt;/Enquiry&gt;

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



EcoCash


EcoCash is a mobile payment solution that enables customers to pay for goods and services by simply using their mobile phones. To do this, the customer must provide their Ecocash registered mobile number on the merchant’s payment application, with it, the customer’s wallet (post authentication) is debited and merchant account credited.

Availability by country: only in Zimbabwe

Merchants can start accepting EcoCash payments by:

  1. Registering for an EcoCash merchant account with our acquiring partners in Zimbabwe
  2. Implement the Debit Instruction command, ensuring that the EcoCash BIN and a registered EcoCash mobile number are concatenated to form the input value for the PAN parameter.
    1. Expiry Date – current or future date must be set in the request.

REST

Request

{

               "Version": "2.0",

               "CertificateID": "{4c96973f-71dd-4044-802d-6e234effe8f2}",

               "ProductType": "Enterprise",

               "ProductVersion": "WebAPI",

               "Direction": "Request",

               "Transaction": {

                              "ApplicationID": "{f7e6ecb1-b15e-4318-b272-e1611a5b85bc}", 

                              "Command": "Debit",

                              "Mode": "LIVE",

                              "MerchantReference":"Testi20250120_1235", 

        "Currency": "ZWG",

        "Amount": "330", 

        "ExpiryDate": "1228",

       "PAN": "9100120773501244"

 

    }

}  

 

Response

{

    "Version": "2.0",

    "Direction": "Response",

    "Transaction": {

        "Amount": "330",

        "CCNumber": "9100........1244",

        "Currency": "ZWG",

        "ExpiryDate": "122028",

        "MerchantReference": "Busi20250120_1235",

        "Terminal": "Default",

        "TransactionIndex": "{A0A927DE-7A07-404F-A1FA-0542ECC31E63}",

        "MerchantName": "Busiswa",

        "MerchantUSN": "870000030000000",

        "Acquirer": "CBZPostilionCBZZimbabwe",

        "AcquirerReference": "20250204:000000105713",

        "AcquirerDate": "20250204",

        "AcquirerTime": "181932",

        "DisplayAmount": "ZiG 3.30",

        "BIN": "910012",

        "Association": "EcoCash",

        "CardType": "Debit SMS",

        "Issuer": "Unknown Issuer",

        "Jurisdiction": "Zimbabwe",

        "PAN": "9100........1244",

        "PANMode": "Keyed",

        "ReconReference": "00105713",

        "CardHolderPresence": "CardNotPresent",

        "MerchantAddress": "Harare",

        "MerchantCity": "Harare",

        "MerchantCountryCode": "ZW",

        "MerchantCountry": "Zimbabwe",

        "DistributorName": "CBZ Bank",

        "ApplicationID": "{F7E6ECB1-B15E-4318-B272-E1611A5B85BC}",

        "Command": "Debit",

        "Mode": "Live",

        "RequestID": "{00B94FAD-8321-42FB-964B-383A690F19A2}",

        "Result": {

            "Status": "-1",

            "Code": "4",

            "Description": "Denied",

            "Source": "CBZPostilionCBZZimbabwe",

            "AppServer": "QA2019GWAPP01",

            "DBServer": "QA2019GWDB02",

            "Gateway": "QA",

            "AcquirerCode": "05",

            "AcquirerDescription": "Do not honor"

        }

    }

}