-
Introduction
-
Commands & Actions
-
Transaction Sequence
-
MasterPass
-
Visa Checkout
-
Foreign Exchange
-
Parameter Description & Action
-
Gateway Domain Knowledge
-
Transaction Result Codes
-
Out Of Band
-
Payment Facilitator
-
Tokenization
-
SOAP API
-
Pos Device Intergration
-
Acquire Contact Information
-
3D Secure
-
Enterprise API Samples
-
Card on File
-
Additional Data Transactions
Block Code
Function: This is an API call to temporarily block a code, which will prevent purchases on the code.
Bock 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 |
REST Example:
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"
}
}
}
SOAP Example:
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><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">
<MerchantReference>Ref_002</MerchantReference>
<MasterPassMerchantID>xxxxx</MasterPassMerchantID>
<MasterPassAction>BlockCode</MasterPassAction>
<MasterPassCode>xxx5104xxx</MasterPassCode>
</Enquiry>
</V_XML>
</request>
</Execute>
</soap:Body>
</soap:Envelope>
Response:
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><V_XML Version="2.0" Direction="Response">
<Enquiry ApplicationID="{xxxxxxxx-68E0-42EB-ABA9-xxxxxxxxxxxx}" Command="MasterPassQuickResponseCode" Mode="Live" RequestID="{xxxxxxx-271A-407D-AB52-xxxxxxxxxxxx}">
<Result Status="0" Code="0" Description="" AppServer="QAGW2012APP1" DBServer="QAGW2012DB2" Gateway="QA" />
<MasterPassAction>BlockCode</MasterPassAction>
</Enquiry>
</V_XML></ExecuteResult></ExecuteResponse></soap:Body></soap:Envelope>