Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 2 of 52 (D998200263-30)
Copyright © 2006 - 2021 MagTek, Inc.
Printed in the United States of America
INFORMATION IN THIS PUBLICATION IS SUBJECT TO CHANGE WITHOUT NOTICE AND
MAY CONTAIN TECHNICAL INACCURACIES OR GRAPHICAL DISCREPANCIES. CHANGES
OR IMPROVEMENTS MADE TO THIS PRODUCT WILL BE UPDATED IN THE NEXT
PUBLICATION RELEASE. NO PART OF THIS DOCUMENT MAY BE REPRODUCED OR
TRANSMITTED IN ANY FORM OR BY ANY MEANS, ELECTRONIC OR MECHANICAL, FOR
ANY PURPOSE, WITHOUT THE EXPRESS WRITTEN PERMISSION OF MAGTEK, INC.
MagTek®, MagnePrint®, and MagneSafe® are registered trademarks of MagTek, Inc.
Magensa™ is a trademark of MagTek, Inc.
DynaPro™ and DynaPro Mini™, are trademarks of MagTek, Inc.
ExpressCard 2000 is a trademark of MagTek, Inc.
IPAD® is a trademark of MagTek, Inc.
IntelliStripe® is a registered trademark of MagTek, Inc.
AAMVA™ is a trademark of AAMVA.
American Express® and EXPRESSPAY FROM AMERICAN EXPRESS® are registered trademarks of
American Express Marketing & Development Corp.
D-PAYMENT APPLICATION SPECIFICATION® is a registered trademark to Discover Financial
Services CORPORATION
MasterCard® is a registered trademark and PayPass™ and Tap & Go™ are trademarks of MasterCard
International Incorporated.
Visa® and Visa payWave® are registered trademarks of Visa International Service Association.
MAS-CON® is a registered trademark of Pancon Corporation.
Molex® is a registered trademark and PicoBlade™ is a trademark of Molex, its affiliates, related
companies, licensors, and/or joint venture partners
ANSI®, the ANSI logo, and numerous other identifiers containing "ANSI" are registered trademarks,
service marks, and accreditation marks of the American National Standards Institute (ANSI).
ISO® is a registered trademark of the International Organization for Standardization.
UL™ and the UL logo are trademarks of UL LLC.
PCI Security Standards Council® is a registered trademark of the PCI Security Standards Council, LLC.
EMV® is a registered trademark in the U.S. and other countries and an unregistered trademark elsewhere.
The EMV trademark is owned by EMVCo, LLC. The Contactless Indicator mark, consisting of four
graduating arcs, is a trademark owned by and used with permission of EMVCo, LLC.
The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc. and any
use of such marks by MagTek is under license.
Google Play™ store, Google Wallet™ payment service, and Android™ platform are trademarks of
Google Inc.
Apple Pay®, iPhone®, iPod®, Mac®, and OS X® are registered trademarks of Apple Inc., registered in
the U.S. and other countries. iPad™ is a trademark of Apple. Inc. App Store
SM
is a service mark of
Apple Inc., registered in the U.S. and other countries. IOS is a trademark or registered trademark of
Cisco in the U.S. and other countries and is used by Apple Inc. under license.
Microsoft®, Windows®, and .NET® are registered trademarks of Microsoft Corporation.
All other system names and product names are the property of their respective owners.
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 3 of 52 (D998200263-30)
Table 0-1 - Revisions
Rev Number
Date
Notes
10
Initial Release
20
Oct 2020
Updated
30
Apr 2021
Added notes for JSON payload support
0 - Table of Contents
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 4 of 52 (D998200263-30)
Table of Contents
Table of Contents .............................................................................................................................................. 4
1 Introduction ............................................................................................................................................... 5
2 MPPGv4 Operations ................................................................................................................................. 6
2.1 GetProcessorReport ......................................................................................................................... 6
2.1.1 INPUT PROPERTIES ................................................................................................................. 6
2.1.2 OUTPUT PROPERTIES .............................................................................................................. 7
2.2 ProcessCardSwipe .......................................................................................................................... 11
2.2.1 INPUT PROPERTIES ............................................................................................................... 11
2.2.2 OUTPUT PROPERTIES ............................................................................................................ 12
2.3 ProcessData .................................................................................................................................... 18
2.3.1 INPUT PROPERTIES ............................................................................................................... 18
2.3.2 OUTPUT PROPERTIES ............................................................................................................ 19
2.4 ProcessManualEntry ...................................................................................................................... 25
2.4.1 INPUT PROPERTIES ............................................................................................................... 25
2.4.2 OUTPUT PROPERTIES ............................................................................................................ 26
2.5 ProcessToken .................................................................................................................................. 31
2.5.1 INPUT PROPERTIES ............................................................................................................... 31
2.5.2 OUTPUT PROPERTIES ............................................................................................................ 32
2.6 ProcessKeyPadEntry ...................................................................................................................... 37
2.6.1 INPUT PROPERTIES ............................................................................................................... 37
2.6.2 OUTPUT PROPERTIES ............................................................................................................ 38
2.7 ProcessReferenceId ....................................................................................................................... 44
2.7.1 INPUT PROPERTIES ............................................................................................................... 44
2.7.2 OUTPUT PROPERTIES ............................................................................................................ 45
3 Fault Codes and Reasons ...................................................................................................................... 51
Appendix A Reserved .................................................................................................................................. 52
1 - Introduction
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 5 of 52 (D998200263-30)
1 Introduction
The purpose of this document is to describe the various operations available in MPPG v4 and their required
or optional input & output parameters. It also provides sample SOAP request & response as reference for
client developers.
If you intend to use JSON payloads instead of SOAP, refer to the JSON help page (i.e.,
…/MPPGv4Service.svc/JSON/help) for templates to various operations (only difference with respect to
sample SOAP requests is for enum values – while SOAP takes in enum-names, in JSON payloads you will
have to provide the enum-values).
MPPGv4 enables clients to easily integrate encrypted & secure payment data from MagTek devices into
their payment applications. This helps mitigate the risks associated with transmission of PCI-sensitive
payment data to third-party (or ‘target’) service providers.
Clients call specific MPPGv4 operations (based on payment mode e.g. card-swipe, EMV, manual entry,
reference-id, token etc.) with corresponding encrypted & secure payment data and transaction information.
The service, upon successful authentication of the client credentials, decrypts the payment data, builds the
transaction request, sends it to the third-party service provider, parses the response and returns the results
of the operation to the client. Please check if your payment processor is supported by MPPGv4 as a third-
party service provider.
For SALE and AUTHORIZE transactions, Partial Authorization is set to TRUE. This will cause the card
issuing bank to authorize up to the amount remaining in the cardholder’s account, even if this is less than
the amount requested. The remainder must be collected by another means. Therefore, it is important to
always check “Authorized Amount” in the output. It may be less than “Amount” requested in the input. For
more information regarding the behavior of Partial Authorization or to disable it, please
contact support@magensa.net
.
All transaction-related information should be provided in the TransactionInput element. And any
information other than processor name, transaction type and amount should be provided as key-value pair
elements in TransactionInputDetails. The building of transaction requests is template-driven through use of
tags and therefore if the payment processor requires this data, the client will have to provide key-value pairs
such as key = “LocalDateTime”, value = “2017-05-11 12:00:00Z”. MPPGv4 will replace the key-tag of
“LocalDateTime” in the template with the value provided as part of building the request. Please consult
your payment processor API for the correct key string-literals.
A unique, new feature introduced in MPPGv4 is the ability to send a “batch” of requests in a single call to
the service. As a result, all MPPGv4 service operations take in an array of requests and return an array of
responses. The service processes these input requests serially and a specific index/element of response
corresponds to the specific index/element of request. All responses have an MPPGv4WSFault element and
in the case of an error or exception raised for that request, the details will be available in the corresponding
MPPGv4Fault element. When successful, the value of this MPPGv4WSFault element will be null.
For Magensa to call the third-party service provider, consideration must be given to the following:
a. Whether Magensa’s IP addresses and domain names must be whitelisted with the third-party
b. Whether client and/or server-side certificates are required.
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 6 of 52 (D998200263-30)
2 MPPGv4 Operations
2.1 GetProcessorReport
2.1.1 INPUT PROPERTIES
Property(*)
Value
Description
AdditionalRequestData
Array of
key / value
Contains custom request data required by the target service
provider. Elements are expressed as key/value pairs grouped
under <KeyValuePairOfstringstring>. See sample request.
Amount *
Decimal
Amount for transaction in units (dollars or cents) as per target
service provider’s API
CustomerCode *
String
Customer code for credential assigned by Magensa
CustomerTransactionID
String
Client-assigned transaction ID for easy cross-reference
Password *
String
Password for credential assigned by Magensa
ProcessorName *
String
Magensa assigned name for third-party service provider
TransactionInputDetails
Array of
key / value
Contains transaction information required by the target service
provider. Elements are expressed as key/value pairs grouped
under <KeyValuePairOfstringstring>. See examples
TransactionType *
String
(Integer for
JSON)
Transaction type:
REPORT
In case of JSON payload, provide enum-integer-value of 9
Username *
String
Username for credential assigned by Magensa
Note: * = Required
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 7 of 52 (D998200263-30)
2.1.2 OUTPUT PROPERTIES
Property
Value
Description
AuthCode
String
Authorization code from target service provider.
AuthorizedAmount
Decimal
Authorized amount from target service provider.
AVSResult
String
Address Verification System result from target service provider.
CustomerTransactionID
String
Client-assigned transaction ID from input.
CVVResult
String
Card Verification Value result from target service provider.
IssuerAuthenticationData
String
Issuer authenticate data from target service provider.
IssuerScriptTemplate1
String
Issuer script template 1 from target service provider.
IssuerScriptTemplate2
String
Issuer script template 2 from target service provider.
IsTransactionApproved
Boolean
Boolean value indicating approval status of the transaction.
MagTranID
String
Transaction ID (GUID) from Magensa.
MPPGv4WSFault
String
Contains FaultCode, FaultReason and additional details when
error encountered while processing particular request.
Otherwise is null
Token
String
Token if target service provider is Magensa’s Token web
service.
TransactionID
String
Transaction ID from target service provider.
TransactionMessage
String
Transaction Message from target service provider.
TransactionOutputDetails
Array of
key /
value
Contains additional output data returned by the target service
provider. Elements are expressed as key / value pairs grouped
under <KeyValuePairOfstringstring>. See examples
TransactionStatus
String
Transaction status from target service provider.
TransactionUTCTimestamp
String
Transaction timestamp from Magensa.
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 8 of 52 (D998200263-30)
GetProcessorReport Request:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mpp="http://www.magensa.net/MPPGv4/"
xmlns:mpp1="http://schemas.datacontract.org/2004/07/MPPGv4WS.Core"
xmlns:sys="http://schemas.datacontract.org/2004/07/System.Collections.
Generic">
<soapenv:Header/>
<soapenv:Body>
<mpp:GetProcessorReport>
<!--Optional:-->
<mpp:GetProcessorReportRequests>
<!--Zero or more repetitions:-->
<mpp1:GetProcessorReportRequest>
<!--Optional:-->
<mpp1:AdditionalRequestData>
<!--Zero or more repetitions:-->
<sys:KeyValuePairOfstringstring>
<sys:key>?</sys:key>
<sys:value>?</sys:value>
</sys:KeyValuePairOfstringstring>
</mpp1:AdditionalRequestData>
<mpp1:Authentication>
<mpp1:CustomerCode>customercode</mpp1:CustomerCode>
<mpp1:Password>password</mpp1:Password>
<mpp1:Username>username</mpp1:Username>
</mpp1:Authentication>
<!--Optional:-->
<mpp1:CustomerTransactionID></mpp1:CustomerTransactionID>
<mpp1:TransactionInput>
<!--Optional:-->
<mpp1:Amount>4</mpp1:Amount>
<mpp1:ProcessorName>VantivExpress - Pilot
Reporting</mpp1:ProcessorName>
<!--Optional:-->
<mpp1:TransactionInputDetails>
<!--Zero or more repetitions:-->
<sys:KeyValuePairOfstringstring>
<sys:key>TransactionID</sys:key>
<sys:value>63158467</sys:value>
</sys:KeyValuePairOfstringstring>
</mpp1:TransactionInputDetails>
<mpp1:TransactionType>REPORT</mpp1:TransactionType>
</mpp1:TransactionInput>
</mpp1:GetProcessorReportRequest>
</mpp:GetProcessorReportRequests>
</mpp:GetProcessorReport>
</soapenv:Body>
</soapenv:Envelope>
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 9 of 52 (D998200263-30)
GetProcessorReport Response:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetProcessorReportResponse
xmlns="http://www.magensa.net/MPPGv4/">
<GetProcessorReportResult
xmlns:a="http://schemas.datacontract.org/2004/07/MPPGv4WS.Core"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:GetProcessorReportResponse>
<a:CustomerTransactionID/>
<a:MPPGv4WSFault i:nil="true"/>
<a:MagTranID>088d8138-6e31-455b-88af-
4a808601abf8</a:MagTranID>
<a:TransactionOutput>
<a:AVSResult i:nil="true"/>
<a:AuthCode>099649</a:AuthCode>
<a:AuthorizedAmount>4.00</a:AuthorizedAmount>
<a:CVVResult i:nil="true"/>
<a:IsTransactionApproved>true</a:IsTransactionApproved>
<a:IssuerAuthenticationData i:nil="true"/>
<a:IssuerScriptTemplate1 i:nil="true"/>
<a:IssuerScriptTemplate2 i:nil="true"/>
<a:Token i:nil="true"/>
<a:TransactionID>63158467</a:TransactionID>
<a:TransactionMessage>Approved</a:TransactionMessage>
<a:TransactionOutputDetails
xmlns:b="http://schemas.datacontract.org/2004/07/System.Collections.Ge
neric">
<b:KeyValuePairOfstringstring>
<b:key>ProcessorResponse</b:key>
<b:value><
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 10 of 52 (D998200263-30)
sactionID>63158467</TransactionID><AcceptorID>4445022937078</AcceptorI
D><AccountID>Accountid</AccountID><Name>VANTIV TEST EMV 160 -
Magensa</Name><TerminalID>0001</TerminalID><ApplicationID>8155</Applic
ationID><ApprovalNumber>099649</ApprovalNumber><ApprovedAmount>4.00</A
pprovedAmount><ExpirationMonth>04</ExpirationMonth><ExpirationYear>16<
/ExpirationYear><ExpressResponseCode>0</ExpressResponseCode><ExpressRe
sponseMessage>Approved</ExpressResponseMessage><HostBatchID>741</HostB
atchID><HostItemID>7</HostItemID><HostResponseCode>00</HostResponseCod
e><OriginalAuthorizedAmount>4.00</OriginalAuthorizedAmount><TicketNumb
er>000000</TicketNumber><TrackingID>E9F2B1C4112944F491D0CA5DD2C17974</
TrackingID><TerminalType>1
</TerminalType><TransactionAmount>4.00</TransactionAmount><Transaction
Status>Approved</TransactionStatus><TransactionStatusCode>1</Transacti
onStatusCode><TransactionType>CreditCardSale</TransactionType><CardNum
berMasked>xxxx-xxxx-xxxx-
6669</CardNumberMasked><CardLogo>Mastercard</CardLogo><CardType>Credit
</CardType><TrackDataPresent>TRUE</TrackDataPresent><HostTransactionID
>100000</HostTransactionID><ExpressTransactionDate>20201014</ExpressTr
ansactionDate><ExpressTransactionTime>052113</ExpressTransactionTime><
TimeStamp>2020-10-
14T05:21:14.053</TimeStamp><LaneNumber>418324</LaneNumber><Integration
TypeID>1</IntegrationTypeID><BatchStatusCode>1</BatchStatusCode><Syste
mTraceAuditNumber>158467</SystemTraceAuditNumber><RetrievalReferenceNu
mber>028805158467</RetrievalReferenceNumber><TerminalData>1|2|2|2|0|3|
2|1|||2|0|9|1|0|1|2|9|2|0|0|0|0|0|0|||
|||</TerminalData><MerchantCategoryCode>5999</MerchantCategoryCode><Ca
rdInputCode>2</CardInputCode></Item></Items></ReportingData><Reporting
ID>95647476</ReportingID></Response></TransactionQueryResponse>]]></b:
value>
</b:KeyValuePairOfstringstring>
</a:TransactionOutputDetails>
<a:TransactionStatus>1</a:TransactionStatus>
</a:TransactionOutput>
<a:TransactionUTCTimestamp>2020-10-14
10:22:53Z</a:TransactionUTCTimestamp>
</a:GetProcessorReportResponse>
</GetProcessorReportResult>
</GetProcessorReportResponse>
</s:Body>
</s:Envelope>
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 11 of 52 (D998200263-30)
2.2 ProcessCardSwipe
This operation processes a batch of Process Card Swipe Request elements for card-swipe payment mode.
2.2.1 INPUT PROPERTIES
Property(*)
Value
Description
AdditionalRequestData
Array of
key /
value
Contains custom request data required by the target service
provider. Elements are expressed as key/value pairs grouped
under <KeyValuePairOfstringstring>. See sample request
Amount *
String
Amount for transaction in units (dollars or cents) as per target
service provider’s API
CustomerCode *
String
Customer code provided by Magensa at onboard time.
CustomerTransactionID
String
Client-assigned transaction ID for easy cross-reference.
CVV
String
Card verification value
DeviceSN
String
MagTek device serial number
KSN *
String
Key Serial Number of the reader
MagnePrint *
String
Encrypted MagnePrint.
MagnePrintPStatus *
String
MagnePrint Status
Password *
String
Password for credential assigned by Magensa
ProcessorName *
String
Magensa assigned name for third-party service provider
Track1
String
Encrypted track 1 data
Track2 *
String
Encrypted track 2 data
Track3
String
Encrypted track 3 data
TransactionInputDetails
Array of
key /
value
Contains transaction information required by the target service
provider. Elements are expressed as key/value pairs grouped
under <KeyValuePairOfstringstring>. See examples
TransactionType *
String
(Integer
for
JSON)
Transaction type:
SALE, AUTHORIZE, CAPTURE, VOID, REFUND, FORCE,
REJECT, TOKEN. In case of JSON payload, provide enum-
integer-value i.e., 1, 2, 3, 4, 5, 6, 7, 8 respectively
Username *
String
Username for credential assigned by Magensa
ZIP
String
Zip code
Note: * = Required
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 12 of 52 (D998200263-30)
2.2.2 OUTPUT PROPERTIES
Property
Value
Description
AdditionalOutputData
Array of
key /
value
Contains additional output data. Elements are expressed as key /
value pairs grouped under
<KeyValuePairOfstringstring>. See examples
AuthCode
String
Authorization code from target service provider.
AuthorizedAmount
Decimal
Authorized amount from target service provider.
AVSResult
String
Address Verification System result from target service provider.
CardID
String
Card ID from Magensa.
CustomerTransactionID
String
Client-assigned transaction ID from input.
CVVResult
String
Card Verification Value result from target service provider.
IsReplay
Boolean
Boolean value indicating prior use of KSN from Magensa.
IssuerAuthenticationData
String
Issuer authenticate data from target service provider.
IssuerScriptTemplate1
String
Issuer script template 1 from target service provider.
IssuerScriptTemplate2
String
Issuer script template 2 from target service provider.
IsTransactionApproved
Boolean
Boolean value indicating approval status of the transaction.
MagnePrintScore
Decimal
MagnePrint score from Magensa.
MagTranID
String
Transaction ID (GUID) from Magensa.
MPPGv4WSFault
String
Contains FaultCode, FaultReason and additional details when
error encountered while processing particular request. Otherwise
is null
Token
String
Token if target service provider is Magensa’s Token web-
service.
TransactionID
String
Transaction ID from target service provider.
TransactionMessage
String
Transaction Message from target service provider.
TransactionOutputDetails
Array of
key /
value
Contains additional output data returned by the target service
provider. Elements are expressed as key / value pairs grouped
under <KeyValuePairOfstringstring>. See examples
TransactionStatus
String
Transaction status from target service provider.
TransactionUTCTimestamp
String
Transaction timestamp from Magensa.
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 13 of 52 (D998200263-30)
ProcessCardSwipe Request:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mpp="http://www.magensa.net/MPPGv4/"
xmlns:mpp1="http://schemas.datacontract.org/2004/07/MPPGv4WS.Core"
xmlns:sys="http://schemas.datacontract.org/2004/07/System.Collections.
Generic">
<soapenv:Header/>
<soapenv:Body>
<mpp:ProcessCardSwipe>
<mpp:ProcessCardSwipeRequests>
<mpp1:ProcessCardSwipeRequest>
<mpp1:AdditionalRequestData>
<sys:KeyValuePairOfstringstring>
<sys:key/>
<sys:value/>
</sys:KeyValuePairOfstringstring>
</mpp1:AdditionalRequestData>
<mpp1:Authentication>
<mpp1:CustomerCode>customercode</mpp1:CustomerCode>
<mpp1:Password>password</mpp1:Password>
<mpp1:Username>username</mpp1:Username>
</mpp1:Authentication>
<mpp1:CardSwipeInput>
<mpp1:CVV>123</mpp1:CVV>
<mpp1:EncryptedCardSwipe>
<mpp1:DeviceSN>B487DBC022119AA</mpp1:DeviceSN>
<mpp1:KSN>9011400B487DBC0000D0</mpp1:KSN>
<mpp1:MagnePrint>BDB8B02E5569C4B6D1F5FFC39C1A9A1377568986A3D99FDF
A9B623A2C6DE340985B54C08EE80F6DDDB08BEE29E061E304AD404CFE91A721A</mpp1
:MagnePrint>
<mpp1:MagnePrintStatus>61403000</mpp1:MagnePrintStatus>
<mpp1:Track1>365219542E85374DA5988757ADFD31982A20CAB580615E214640
4293F6A55B838AA2F33BDCEC61FFDDFDFD4C36C5719712AA269EA3C598B9400A0F7EE1
DD283ADBF14BB4A74A8516460405C95060B123</mpp1:Track1>
<mpp1:Track2>07CCAC9B925B2460CC81E463372157A1091338F355FD63FEAE85
3DFF2979176769F305601F292FA4</mpp1:Track2>
<mpp1:Track3/>
</mpp1:EncryptedCardSwipe>
<mpp1:ZIP>12345</mpp1:ZIP>
</mpp1:CardSwipeInput>
<mpp1:CustomerTransactionID>MPPGv4
ProcessCardSwipe</mpp1:CustomerTransactionID>
<mpp1:TransactionInput>
<mpp1:Amount>2</mpp1:Amount>
<mpp1:ProcessorName>Rapid Connect v3 - Pilot</mpp1:ProcessorName>
<mpp1:TransactionInputDetails>
<sys:KeyValuePairOfstringstring>
<sys:key/>
<sys:value/>
</sys:KeyValuePairOfstringstring>
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 14 of 52 (D998200263-30)
</mpp1:TransactionInputDetails>
<mpp1:TransactionType>SALE</mpp1:TransactionType>
</mpp1:TransactionInput>
</mpp1:ProcessCardSwipeRequest>
</mpp:ProcessCardSwipeRequests>
</mpp:ProcessCardSwipe>
</soapenv:Body>
</soap:envelop>
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 15 of 52 (D998200263-30)
ProcessCardSwipe Response:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ProcessCardSwipeResponse
xmlns="http://www.magensa.net/MPPGv4/">
<ProcessCardSwipeResult
xmlns:a="http://schemas.datacontract.org/2004/07/MPPGv4WS.Core"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:ProcessCardSwipeResponse>
<a:AdditionalResponseData i:nil="true"
xmlns:b="http://schemas.datacontract.org/2004/07/System.Collections.Ge
neric"/>
<a:CardSwipeOutput>
<a:AdditionalOutputData
xmlns:b="http://schemas.datacontract.org/2004/07/System.Collections.Ge
neric">
<b:KeyValuePairOfstringstring>
<b:key>Token</b:key>
<b:value>FA820115DFE0012466303636373936382D396332392D346137392D3839353
72D653039616662373033383964DFE00205312E302E30DFE00421323032322D30332D3
3305430333A34353A31352E303030303030302D30373A3030DFE0050450726F64DFE00
61C323031392D30372D30345431303A34353A31372E323339373730315ADFE0070A4D4
93537323734373430DFE0080731303030303132DFE0092435303166343265622D39643
6352D346366622D396437642D616530633165663930396539DFE01120F17557FD79CEE
AFDF3FD11E085F73F22F6160574B38AC8F56538DA1D9C81F33EDFE0120A90114000000
00003501DDFE003205540C3B1663A472532C082B9B2362601E56E1970B27CDF673BB85
09D9D648FE2</b:value>
</b:KeyValuePairOfstringstring>
<b:KeyValuePairOfstringstring>
<b:key>CardType</b:key>
<b:value>VISA</b:value>
</b:KeyValuePairOfstringstring>
</a:AdditionalOutputData>
<a:CardID/>
<a:IsReplay>true</a:IsReplay>
<a:MagnePrintScore>0.0130942</a:MagnePrintScore>
<a:PANLast4>0119</a:PANLast4>
</a:CardSwipeOutput>
<a:CustomerTransactionID>MPPGv4
ProcessCardSwipe</a:CustomerTransactionID>
<a:MPPGv4WSFault i:nil="true"/>
<a:MagTranID>6f8defef-b468-4c51-ae0c-
6bb4b4dcd80e</a:MagTranID>
<a:TransactionOutput>
<a:AVSResult>Z</a:AVSResult>
<a:AuthCode>OK1805</a:AuthCode>
<a:AuthorizedAmount>2</a:AuthorizedAmount>
<a:CVVResult i:nil="true"/>
<a:IsTransactionApproved>true</a:IsTransactionApproved>
<a:IssuerAuthenticationData i:nil="true"/>
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 16 of 52 (D998200263-30)
<a:IssuerScriptTemplate1 i:nil="true"/>
<a:IssuerScriptTemplate2 i:nil="true"/>
<a:Token>FA820115DFE0012466303636373936382D396332392D346137392D3839353
72D653039616662373033383964DFE00205312E302E30DFE00421323032322D30332D3
3305430333A34353A31352E303030303030302D30373A3030DFE0050450726F64DFE00
61C323031392D30372D30345431303A34353A31372E323339373730315ADFE0070A4D4
93537323734373430DFE0080731303030303132DFE0092435303166343265622D39643
6352D346366622D396437642D616530633165663930396539DFE01120F17557FD79CEE
AFDF3FD11E085F73F22F6160574B38AC8F56538DA1D9C81F33EDFE0120A90114000000
00003501DDFE003205540C3B1663A472532C082B9B2362601E56E1970B27CDF673BB85
09D9D648FE2</a:Token>
<a:TransactionID>019185036512227G678</a:TransactionID>
<a:TransactionMessage>APPROVAL</a:TransactionMessage>
<a:TransactionOutputDetails
xmlns:b="http://schemas.datacontract.org/2004/07/System.Collections.Ge
neric">
<b:KeyValuePairOfstringstring>
<b:key>ProcessorResponse</b:key>
<b:value><![CDATA[HTTP/1.1 200 OKKeep-Alive:
timeout=60, max=100
Connection: Keep-Alive
Content-Length: 1269
Content-Type: text/xml
Date: Thu, 04 Jul 2019 10:45:17 GMT
Server: Apache
&<?xml version="1.0" encoding="UTF-8"?>
<Response Version="3" xmlns="http://securetransport.dw/rcservice/xml">
<RespClientID>
<DID>00012443241234679102</DID>
<ClientRef>0006571VRMA015</ClientRef>
</RespClientID>
<Status StatusCode="OK"></Status>
<TransactionResponse>
<ReturnCode>000</ReturnCode>
<Payload Encoding="cdata"><![CDATA[<?xml version="1.0"
encoding="utf-8"?><GMF xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="com/firstdata/Merchant/gmfV6.10"><CreditResponse><CommonGrp><Py
mtType>Credit</PymtType><TxnType>Sale</TxnType><LocalDateTime>20190704
034516</LocalDateTime><TrnmsnDateTime>20190704104519</TrnmsnDateTime><
STAN>088112</STAN><RefNum>000000088112</RefNum><OrderNum>00088112</Ord
erNum><TermID>00000001</TermID><MerchID>RCTST0000006128</MerchID><TxnA
mt>2</TxnAmt><TxnCrncy>840</TxnCrncy></CommonGrp><CardGrp><AcctNum>476
173******0119</AcctNum><AVSResultCode>Z</AVSResultCode></CardGrp><Visa
Grp><ACI>E</ACI><TransID>019185036512227G678</TransID></VisaGrp><RespG
rp><RespCode>000</RespCode><AuthID>OK1805</AuthID><AddtlRespData>APPRO
VAL</AddtlRespData><AthNtwkID>02</AthNtwkID><AthNtwkNm>VISA</AthNtwkNm
></RespGrp></CreditResponse></GMF>]]]]>><![CDATA[</Payload>
</TransactionResponse>
</Response>]]></b:value>
</b:KeyValuePairOfstringstring>
</a:TransactionOutputDetails>
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 17 of 52 (D998200263-30)
<a:TransactionStatus>000</a:TransactionStatus>
</a:TransactionOutput>
<a:TransactionUTCTimestamp>2019-07-04
10:45:15Z</a:TransactionUTCTimestamp>
</a:ProcessCardSwipeResponse>
</ProcessCardSwipeResult>
</ProcessCardSwipeResponse>
</s:Body>
</s:Envelope>
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 18 of 52 (D998200263-30)
2.3 ProcessData
This operation processes a batch/single of ProcessDataEMVRequest elements for EMV payment mode.
2.3.1 INPUT PROPERTIES
Property(*)
Value
Description
AdditionalRequestData
Array of
key / value
Contains custom request data required by the target service
provider. Elements are expressed as key/value pairs
grouped under <KeyValuePairOfstringstring>. See sample
request.
Amount *
Decimal
Amount for transaction in units (dollars or cents) as per
target service provider’s API.
CustomerCode *
String
Customer code for credential assigned by Magensa.
CustomerTransactionID
String
Client-assigned transaction ID from input.
Data *
String
Encrypted EMV transaction data (ARQC) from device.
DataFormatType *
String
(Integer
for JSON)
Format of Data: “TLV”, “NONE”
In case of JSON payload, provide enum-integer-value i.e.,
0, 1 respectively
EncryptionType *
String
Encryption type used for Data:
80 (DUKPT Key Data Variant), 81 (DUKPT Key PIN
Variant). If present in encrypted EMV transaction data
from device, that value overrides this input value
KSN *
String
Key serial number
NumberOfPaddedBytes *
String
Number of bytes padded to the end of the decrypted
Data to make a multiple of 8 bytes.
Password *
String
Password for credential assigned by Magensa.
PaymentMode *
String
(Integer
for JSON)
Mode of transaction payment:
EMV, MagStripe (fallback option for EMV). In case of
JSON payload, provide enum-integer-value i.e., 2, 1
respectively
ProcessorName *
String
Magensa assigned name for third-party service provider.
MagTranID
String
Transaction ID (GUID) from Magensa.
TransactionOutputDetails
Array of
key / value
Contains transaction information required by the target
service provider. Elements are expressed as key/value pairs
grouped under <KeyValuePairOfstringstring>.
TransactionType *
String
(Integer
for JSON)
Transaction type:
SALE, AUTHORIZE, CAPTURE, VOID, REFUND,
FORCE, REJECT. In case of JSON payload, provide
enum-integer-value i.e., 1, 2, 3, 4, 5, 6, 7 respectively
Username *
String
Username for credential assigned by Magensa.
Note: * = Required
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 19 of 52 (D998200263-30)
2.3.2 OUTPUT PROPERTIES
Property
Value
Description
AdditionalOutputData
Array of
key /
value
Contains additional output data. Elements are expressed as
key / value pairs grouped under
<KeyValuePairOfstringstring>. See examples
AuthCode
String
Authorization code from target service provider.
AuthorizedAmount
Decimal
Authorized amount from target service provider.
AVSResult
String
Address Verification System result from target service
provider.
CardID
String
Card ID from Magensa.
CustomerTransactionID
String
Client-assigned transaction ID from input.
CVVResult
String
Card Verification Value result from target service provider.
IsReplay
Boolean
Boolean value indicating prior use of KSN from Magensa.
IssuerAuthenticationData
String
Issuer authenticate data from target service provider.
IssuerScriptTemplate1
String
Issuer script template 1 from target service provider.
IssuerScriptTemplate2
String
Issuer script template 2 from target service provider.
IsTransactionApproved
Boolean
Boolean value indicating approval status of the transaction.
MagTranID
String
Transaction ID (GUID) from Magensa.
MPPGv4WSFault
String
Contains FaultCode, FaultReason and additional details
when error encountered while processing particular request.
Otherwise is null
Token
String
Token if target service provider is Magensa’s Token web
service.
TransactionID
String
Transaction ID from target service provider.
TransactionMessage
String
Transaction Message from target service provider.
TransactionOutputDetails
Array of
key /
value
Contains additional output data returned by the target
service provider. Elements are expressed as key / value
pairs grouped under <KeyValuePairOfstringstring>. See
examples
TransactionStatus
String
Transaction status from target service provider.
TransactionUTCTimestamp
String
Transaction timestamp from Magensa.
2 - MPPGv4 Operations
Magensa Payment Protection Gateway| MPPGv4.0 | Programmer’s Reference Manual
Page 20 of 52 (D998200263-30)
Process Data Request (EMV payment Mode Transaction):
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mpp="http://www.magensa.net/MPPGv4/"
xmlns:mpp1="http://schemas.datacontract.org/2004/07/MPPGv4WS.Core"
xmlns:sys="http://schemas.datacontract.org/2004/07/System.Collections.
Generic">
<soapenv:Header/><soapenv:Body><mpp:ProcessData>
<mpp:ProcessDataRequests>
<mpp1:ProcessDataRequest>
<mpp1:AdditionalRequestData>
<sys:KeyValuePairOfstringstring>
<sys:key/>
<sys:value/></sys:KeyValuePairOfstringstring>
</mpp1:AdditionalRequestData><mpp1:Authentication>
<mpp1:CustomerCode>customercode</mpp1:CustomerCode>
<mpp1:Password>password</mpp1:Password>
<mpp1:Username>username</mpp1:Username></mpp1:Authentication>
<mpp1:CustomerTransactionID>12345</mpp1:CustomerTransactionID>
<mpp1:DataInput>
<mpp1:Data>020BF9820207DFDF540A00000000000000000000DFDF550182DFDF250F4
23438374442433032323131394141FA8201DD708201D9DFDF5301005F201A554154205
553412F5465737420436172642031332020202020205F30020201DFDF4D273B3337343
230303039303030313030333D3234313232303130303030303030303030303030303FD
FDF520105F882017EDFDF59820160B8CEF07895D6B8DC79AAADBD693079C568763A905
F369189EB14FAA904BA981937F3FB75A4B96B2729368415D59EC403293E87A8EA605D5
F66F4C3B6B89BB83AA369F732AA0961936DBC21F360706C781CDA06B374261FBA815F8
13B79663E33AD6FD40B6EE9F934D7D0EA216FC878C12670136158EEDDCEA861F3370B3
7372C16A16FFAA57257B214B678662CFF6332E03C1BE4AC579AF220743F12340865988
45CB458511C2D27E264B357AEB66C23F5195C832B0180EFA9750DA54CEF4021E2E9F56
0614CB061C0FD9F119FB182391F078C2E5DBD6F6693D6A998BBEBAC014960E4C9B44BC
202535CAEC6432A58AFC97C64706F75D0F603956C6BACB16C33A426439A075C6FAB783
D724C6A25869E8D438C1B28DD25ACEDA6F127F66361F9CC216D89DF03BF9F9C2C8CE2C
489EB16F3A8E919653CBD74D516CD3B2572F0A0FD52FEC6BB72C69B8D3D2B106355C3E
CC193F1B8F4E49A63E35679C797ADAC12DFDF560A9011400B487DBC000074DFDF57018
0DFDF580107000000000011223344</mpp1:Data>
<mpp1:DataFormatType>TLV</mpp1:DataFormatType>
<mpp1:EncryptionInfo>
<mpp1:EncryptionType>80</mpp1:EncryptionType>
<mpp1:KSN>9011400B487DBC000074</mpp1:KSN>
<mpp1:NumberOfPaddedBytes>0</mpp1:NumberOfPaddedBytes>
</mpp1:EncryptionInfo>
<mpp1:IsEncrypted>true</mpp1:IsEncrypted>
<mpp1:PaymentMode>EMV</mpp1:PaymentMode>
</mpp1:DataInput>
<mpp1:TransactionInput>
<mpp1:Amount>2</mpp1:Amount>
<mpp1:ProcessorName>Rapid Connect v3 -
Pilot</mpp1:ProcessorName><mpp1:TransactionInputDetails>
<sys:KeyValuePairOfstringstring>
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
/