{"info":{"_postman_id":"93622380-e92d-4708-ba2e-939404ac4bd2","name":"PayPal/Venmo","description":"

Purpose of the document

\n

The purpose of this document is to describe the Instructions on support for PayPal\\Venmo and their
required or optional input & output parameters. It also provides sample SOAP request & response as
reference for client developers.

\n

Prerequisite:

\n\n

MPPGv4’s ProcessData and MPPGv3’s ProcessEMVSRED operations support “SALE” transaction-typefor PayPal QRC. And their ProcessReferenceID operation supports “VOID” and “REFUND” transaction-types.

\n

Instructions for Process QRC-based transactions

\n

MPPGv4’s ProcessData and MPPGv3’s ProcessEMVSRED operations support “SALE” transaction-typefor PayPal QRC. And their ProcessReferenceID operation supports “VOID” and “REFUND” transaction-types.

\n

In ALL PayPal QRC-based transactions, in addition to the MPPG Authentication fields, ProcessorName and TransactionType, the client must provide a key-value pair in AdditionalRequestData with “ForHeader_PayPal-Request-Id” as the key. Its value will be sent to PayPal as PayPal-Request-Id (As per PayPal’s documentation, this is a ‘ _Unique request id. To be used for idempotency checks if necessary._This is the idempotency id to be used in the Cancel request. ’).

\n

In the case of “SALE” transaction-type, the merchant-assigned store-Id must be provided as a key-value pair in TransactionInputDetails with “point_of_sale_details.store_details.external_id” as the key.

\n

As for PayPal QRCs, they can be input as clear-text string or as encrypted data from a MagTek reader capable of scanning QRCs. When a clear-text string, the QRC must be provided as a key-value pair in TransactionInputDetails with “credential_info.customer.qr_code” as the key. However, when input as encrypted reader data, the corresponding DataInput/EMVSREDInput fields must be
populated.

\n

For “VOID” transaction-type, the PayPal-Request-Id of the original “SALE” transaction must be
provided as a key-value pair in TransactionInputDetails with “original_request_idempotency_key” as the key.

\n

Finally, for “REFUND” transaction-type, the merchant-assigned store-id must be provided as a key-value pair in TransactionInputDetails with “store_details.external_id” as the key. In addition, the transaction-Id of the original “SALE” transaction must be provided as input ReferenceTransactionID.

\n

2 Processing Requests

\n

2.1 Sale with Clear-text QRC

\n
<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\">\n  <soapenv:Header/>\n  <soapenv:Body>\n    <mpp:ProcessData>\n      <mpp:ProcessDataRequests>\n        <mpp1:ProcessDataRequest>\n          <mpp1:AdditionalRequestData>\n            <sys:KeyValuePairOfstringstring>\n              <sys:key>ForHeader_PayPal-Request-Id</sys:key>\n              <sys:value>12345</sys:value>\n            </sys:KeyValuePairOfstringstring>\n          </mpp1:AdditionalRequestData>\n          <mpp1:Authentication>\n            <mpp1:CustomerCode>{CustomerCode}</mpp1:CustomerCode>\n            <mpp1:Password>{Password}</mpp1:Password>\n            <mpp1:Username>{Username}</mpp1:Username>\n          </mpp1:Authentication>\n          <mpp1:CustomerTransactionID>12345</mpp1:CustomerTransactionID>\n          <mpp1:DataInput>\n            <mpp1:Data/>\n            <mpp1:DataFormatType>NONE</mpp1:DataFormatType>\n            <mpp1:IsEncrypted>false</mpp1:IsEncrypted>\n            <mpp1:PaymentMode>None</mpp1:PaymentMode>\n          </mpp1:DataInput>\n          <mpp1:TransactionInput>\n            <mpp1:Amount>1.00</mpp1:Amount>\n            <mpp1:ProcessorName>PayPalQRC </mpp1:ProcessorName>\n            <mpp1:TransactionInputDetails>\n              <sys:KeyValuePairOfstringstring>\n                <sys:key>credential_info.customer.qr_code</sys:key>\n                <sys:value>791234567890</sys:value>\n              </sys:KeyValuePairOfstringstring>\n              <sys:KeyValuePairOfstringstring>\n                <sys:key>point_of_sale_details.store_details.external_id</sys:key>\n                <sys:value>123 </sys:value>\n              </sys:KeyValuePairOfstringstring>\n            </mpp1:TransactionInputDetails>\n            <mpp1:TransactionType>SALE</mpp1:TransactionType>\n          </mpp1:TransactionInput>\n        </mpp1:ProcessDataRequest>\n      </mpp:ProcessDataRequests>\n    </mpp:ProcessData>\n  </soapenv:Body>\n</soapenv:Envelope>\n\n
\n

2.2 Sale with Encrypted QRC

\n
<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\">\n  <soapenv:Header/>\n  <soapenv:Body>\n    <mpp:ProcessData>\n      <mpp:ProcessDataRequests>\n        <mpp1:ProcessDataRequest>\n          <mpp1:AdditionalRequestData>\n            <sys:KeyValuePairOfstringstring>\n              <sys:key>ForHeader_PayPal-Request-Id</sys:key>\n              <sys:value>12345</sys:value>\n            </sys:KeyValuePairOfstringstring>\n          </mpp1:AdditionalRequestData>\n          <mpp1:Authentication>\n            <mpp1:CustomerCode>{CustomerCode}</mpp1:CustomerCode>\n            <mpp1:Password>{Password}</mpp1:Password>\n            <mpp1:Username>{Username}</mpp1:Username>\n          </mpp1:Authentication>\n          <mpp1:CustomerTransactionID>12345</mpp1:CustomerTransactionID>\n          <mpp1:DataInput>\n            <mpp1:Data>{Data}</mpp1:Data>\n            <mpp1:DataFormatType>TLV</mpp1:DataFormatType>\n            <mpp1:EncryptionInfo>\n              <mpp1:EncryptionType>{EncryptionType}</mpp1:EncryptionType>\n              <mpp1:KSN>{KSN}</mpp1:KSN>\n              <mpp1:NumberOfPaddedBytes>{NumberOfPaddedBytes}</mpp1:NumberOfPaddedBytes>\n            </mpp1:EncryptionInfo>\n            <mpp1:IsEncrypted>true</mpp1:IsEncrypted>\n            <mpp1:PaymentMode>EMV</mpp1:PaymentMode>\n          </mpp1:DataInput>\n          <mpp1:TransactionInput>\n            <mpp1:Amount>1.00</mpp1:Amount>\n            <mpp1:ProcessorName>PayPalQRC </mpp1:ProcessorName>\n            <mpp1:TransactionInputDetails>\n              <sys:KeyValuePairOfstringstring>\n                <sys:key>point_of_sale_details.store_details.external_id</sys:key>\n                <sys:value>123</sys:value>\n              </sys:KeyValuePairOfstringstring>\n            </mpp1:TransactionInputDetails>\n            <mpp1:TransactionType>SALE</mpp1:TransactionType>\n          </mpp1:TransactionInput>\n        </mpp1:ProcessDataRequest>\n      </mpp:ProcessDataRequests>\n    </mpp:ProcessData>\n  </soapenv:Body>\n</soapenv:Envelope>\n\n
\n

2.3 Void QRC Transaction

\n
<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\">\n  <soapenv:Header/>\n  <soapenv:Body>\n    <mpp:ProcessReferenceID>\n      <mpp:ProcessReferenceIDRequests>\n        <mpp1:ProcessReferenceIDRequest>\n          <mpp1:AdditionalRequestData>\n            <sys:KeyValuePairOfstringstring>\n              <sys:key>ForHeader_PayPal-Request-Id</sys:key>\n              <sys:value>12345</sys:value>\n            </sys:KeyValuePairOfstringstring>\n          </mpp1:AdditionalRequestData>\n          <mpp1:Authentication>\n            <mpp1:CustomerCode>{CustomerCode}</mpp1:CustomerCode>\n            <mpp1:Password>{Password}</mpp1:Password>\n            <mpp1:Username>{Username}</mpp1:Username>\n          </mpp1:Authentication>\n          <mpp1:CustomerTransactionID>12345</mpp1:CustomerTransactionID>\n          <mpp1:TransactionInput>\n            <mpp1:ProcessorName>PayPalQRC </mpp1:ProcessorName>\n            <mpp1:TransactionInputDetails>\n              <sys:KeyValuePairOfstringstring>\n                <sys:key>original_request_idempotency_key</sys:key>\n                <sys:value>1234</sys:value>\n              </sys:KeyValuePairOfstringstring>\n            </mpp1:TransactionInputDetails>\n            <mpp1:TransactionType>VOID</mpp1:TransactionType>\n            <mpp1:ReferenceTransactionID/>\n          </mpp1:TransactionInput>\n        </mpp1:ProcessReferenceIDRequest>\n      </mpp:ProcessReferenceIDRequests>\n    </mpp:ProcessReferenceID>\n  </soapenv:Body>\n</soapenv:Envelope>\n\n
\n

2.4 REFUND QRC Transaction

\n
<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\">\n  <soapenv:Header/>\n  <soapenv:Body>\n    <mpp:ProcessReferenceID>\n      <mpp:ProcessReferenceIDRequests>\n        <mpp1:ProcessReferenceIDRequest>\n          <mpp1:AdditionalRequestData>\n            <sys:KeyValuePairOfstringstring>\n              <sys:key>ForHeader_PayPal-Request-Id</sys:key>\n              <sys:value>12345</sys:value>\n            </sys:KeyValuePairOfstringstring>\n          </mpp1:AdditionalRequestData>\n          <mpp1:Authentication>\n            <mpp1:CustomerCode>{CustomerCode}</mpp1:CustomerCode>\n            <mpp1:Password>{Password}</mpp1:Password>\n            <mpp1:Username>{Username}</mpp1:Username>\n          </mpp1:Authentication>\n          <mpp1:CustomerTransactionID>12345</mpp1:CustomerTransactionID>\n          <mpp1:TransactionInput>\n            <mpp1:Amount>1.00</mpp1:Amount>\n            <mpp1:ProcessorName>PayPalQRC </mpp1:ProcessorName>\n            <mpp1:TransactionInputDetails>\n              <sys:KeyValuePairOfstringstring>\n                <sys:key>store_details.external_id</sys:key>\n                <sys:value>123 </sys:value>\n              </sys:KeyValuePairOfstringstring>\n            </mpp1:TransactionInputDetails>\n            <mpp1:TransactionType>REFUND</mpp1:TransactionType>\n            <mpp1:ReferenceTransactionID>{ReferenceTransactionID}</mpp1:ReferenceTransactionID>\n          </mpp1:TransactionInput>\n        </mpp1:ProcessReferenceIDRequest>\n      </mpp:ProcessReferenceIDRequests>\n    </mpp:ProcessReferenceID>\n  </soapenv:Body>\n</soapenv:Envelope>\n\n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33729815","collectionId":"93622380-e92d-4708-ba2e-939404ac4bd2","publishedId":"2sAYJ1jgwJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-17T22:09:07.000Z"},"item":[{"name":"ProcessData","id":"9cdb9f4f-df32-47e1-b1ff-73d735d6a551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[{\r\n \"AdditionalRequestData\":[{\r\n \"key\":\"\",\r\n \"value\":\"\"\r\n }],\r\n \"Authentication\":{\r\n \"CustomerCode\":\"\",\r\n \"Password\":\"\",\r\n \"Username\":\"\"\r\n },\r\n \"CustomerTransactionID\":\"\",\r\n \"DataInput\":{\r\n \"Data\":\"\",\r\n \"DataFormatType\":,\r\n \"EncryptionInfo\":{\r\n\t\"EncryptionType\":\"\",\r\n\t\"KSN\":\"\",\r\n\t\"NumberOfPaddedBytes\":\r\n },\r\n \"IsEncrypted\":,\r\n \"PaymentMode\":\r\n },\r\n \"TransactionInput\":{\r\n \"Amount\":,\r\n \"ProcessorName\":\"\",\r\n \"TransactionInputDetails\":[{\r\n \"key\":\"\",\r\n \"value\":\"\"\r\n }],\r\n \"TransactionType\":\r\n }\r\n}]","options":{"raw":{"language":"json"}}},"url":"https://mppg.magensa.net/v4/MPPGv4Service.svc/JSON/ProcessData","urlObject":{"protocol":"https","path":["v4","MPPGv4Service.svc","JSON","ProcessData"],"host":["mppg","magensa","net"],"query":[],"variable":[]}},"response":[{"id":"1efc8744-5c9e-419c-bf41-e4673ac16a86","name":"With Clear QR Code","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[{\r\n \"AdditionalRequestData\":[{\r\n \"key\":\"ForHeader_PayPal-Request-Id\",\r\n \"value\":\"{{ForHeader_PayPal-Request-Id}}\"\r\n }],\r\n \"Authentication\":{\r\n \"CustomerCode\": \"{{CustomerCode}}\",\r\n \"Password\": \"{{Password}}\",\r\n \"Username\": \"{{Username}}\"\r\n },\r\n \"CustomerTransactionID\":\"X\",\r\n \"DataInput\":{\r\n \"Data\":\"\",\r\n \"DataFormatType\":1,\r\n \"IsEncrypted\":false,\r\n \"PaymentMode\":-1\r\n },\r\n \"TransactionInput\":{\r\n \"Amount\":1.23,\r\n \"ProcessorName\":\"PayPalQRC-Sandbox\",\r\n \"TransactionInputDetails\":[{\r\n \"key\":\"credential_info.customer.qr_code\",\r\n \"value\":\"{{credential_info.customer.qr_code}}\"\r\n },\r\n {\r\n \"key\":\"point_of_sale_details.store_details.external_id\",\r\n \"value\":\"{{point_of_sale_details.store_details.external_id}}\"\r\n }],\r\n \"TransactionType\":1\r\n }\r\n}]","options":{"raw":{"language":"json"}}},"url":"https://mppg.magensa.net/v4/MPPGv4Service.svc/JSON/ProcessData"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"73c330bb-68b7-44ba-8c5d-4a4ba63ed184","name":"With Encrypted QR Code","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[{\r\n \"AdditionalRequestData\":[{\r\n \"key\":\"ForHeader_PayPal-Request-Id\",\r\n \"value\":\"{{ForHeader_PayPal-Request-Id}}\"\r\n }],\r\n \"Authentication\":{\r\n \"CustomerCode\": \"{{CustomerCode}}\",\r\n \"Password\": \"{{Password}}\",\r\n \"Username\": \"{{Username}}\"\r\n },\r\n \"CustomerTransactionID\":\"X\",\r\n \"DataInput\":{\r\n \"Data\":\"46F787EB60AE8B65E06E4653860B335C17FB0FBDCEC62C2B\",\r\n \"DataFormatType\":0,\r\n \"EncryptionInfo\":{\r\n \"EncryptionType\":\"80\",\r\n \"KSN\":\"FFFF9876543210200009\",\r\n \"NumberOfPaddedBytes\":0\r\n },\r\n \"IsEncrypted\":true,\r\n \"PaymentMode\":2\r\n },\r\n \"TransactionInput\":{\r\n \"Amount\":1.23,\r\n \"ProcessorName\":\"PayPalQRC-Sandbox\",\r\n \"TransactionInputDetails\":[{\r\n \"key\":\"point_of_sale_details.store_details.external_id\",\r\n \"value\":\"{{point_of_sale_details.store_details.external_id}}\"\r\n }],\r\n \"TransactionType\":1\r\n }\r\n}]","options":{"raw":{"language":"json"}}},"url":"https://mppg.magensa.net/v4/MPPGv4Service.svc/JSON/ProcessData"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9cdb9f4f-df32-47e1-b1ff-73d735d6a551"}]}