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 | 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><V_XML Version="2.0" CertificateID="xxxxxxxx-71dd-4044-802d-xxxxxxxxxxxx" ProductType="Enterprise" ProductVersion="iVeriWebService" Direction="Request"> <Enquiry ApplicationID="xxxxxxxx-68e0-42eb-aba9-xxxxxxxxxxxx" Command="MasterPassQuickResponseCode" Mode="LIVE"> <Amount>1075</Amount> <Currency>ZAR</Currency> <MerchantReference>Ref_002</MerchantReference> <MasterPassMerchantID>xxxxx</MasterPassMerchantID> <MasterPassAction>CreateCode</MasterPassAction> <MasterPassShortDescription>TestProduct1</MasterPassShortDescription> </Enquiry> </V_XML> </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><V_XML Version="2.0" Direction="Response">
|