{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"93622380-e92d-4708-ba2e-939404ac4bd2","name":"PayPal/Venmo","description":"## Purpose of the document\n\nThe purpose of this document is to describe the Instructions on support for PayPal\\\\Venmo and their  \nrequired or optional input & output parameters. It also provides sample SOAP request & response as  \nreference for client developers.\n\n## Prerequisite:\n\n- Merchant onboarded to MPPG and PayPal\n    \n- PayPal mobile app to generate new QRCs\n    \n\nMPPGv4’s ProcessData and MPPGv3’s ProcessEMVSRED operations support “SALE” transaction-typefor PayPal QRC. And their ProcessReferenceID operation supports “VOID” and “REFUND” transaction-types.\n\n## Instructions for Process QRC-based transactions\n\nMPPGv4’s ProcessData and MPPGv3’s ProcessEMVSRED operations support “SALE” transaction-typefor PayPal QRC. And their ProcessReferenceID operation supports “VOID” and “REFUND” transaction-types.\n\nIn 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\nIn 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\nAs 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  \npopulated.\n\nFor “VOID” transaction-type, the PayPal-Request-Id of the original “SALE” transaction must be  \nprovided as a key-value pair in TransactionInputDetails with “original_request_idempotency_key” as the key.\n\nFinally, 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\n## 2 Processing Requests\n\n### 2.1 Sale with Clear-text QRC\n\n``` xml\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\n### 2.2 Sale with Encrypted QRC\n\n``` xml\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\n### 2.3 Void QRC Transaction\n\n``` xml\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\n### 2.4 REFUND QRC Transaction\n\n``` xml\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 ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33729815","team":6083045,"collectionId":"93622380-e92d-4708-ba2e-939404ac4bd2","publishedId":"2sAYJ1jgwJ","public":true,"publicUrl":"https://paypal-venmo.developer.magtek.com","privateUrl":"https://go.postman.co/documentation/33729815-93622380-e92d-4708-ba2e-939404ac4bd2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.3","publishDate":"2024-12-17T22:09:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/54710abbcbe0595b52ebedcdb464cfaf3ee177ca1c5a5d0850c1dc24c3508caf","favicon":"https://res.cloudinary.com/postman/image/upload/v1741199418/team/2b0e542073ba9f727998a67f8bd10fe7.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://paypal-venmo.developer.magtek.com/view/metadata/2sAYJ1jgwJ"}