{"__v":14,"_id":"573256157b51b60e008f3bda","category":{"__v":0,"_id":"573255c0384fc70e0050ea42","project":"573243608b55962900f063c0","version":"573243608b55962900f063c1","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-10T21:42:24.258Z","from_sync":false,"order":5,"slug":"status","title":"Status Request"},"parentDoc":null,"project":"573243608b55962900f063c0","user":"5716534c893cbe0e002d7647","version":{"__v":9,"_id":"573243608b55962900f063c1","project":"573243608b55962900f063c0","createdAt":"2016-04-19T15:51:35.494Z","releaseDate":"2016-04-19T15:51:35.494Z","categories":["573243608b55962900f063c3","573243608b55962900f063c2","573255b9ee92510e00087821","573255c0384fc70e0050ea42","573255ce9ef0fa0e0083f0d4","57334604b90dba1900b3d90c","5733474f45fc0c0e00c154da","57348e6e6a42521700a246fb","57348e79a210200e005f99e2","5734efd57e13fd17002f1129","5746204e04f2410e00a5a2e4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-10T21:43:49.692Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Production Environment:\\nhttps://mws2.safetypay.com/express/ws/v.3.0/\\n\\nSandbox Environment:\\nhttps://sandbox-mws2.safetypay.com/express/ws/v.3.0/\",\n  \"title\": \"Endpoints\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"GETOPERATION\"\n}\n[/block]\nThis method retrieves all operation activity for a specific operation.\n\n**Request Fields**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Values\",\n    \"0-0\": \"ApiKey\",\n    \"1-0\": \"RequestDateTime\",\n    \"2-0\": \"MerchantSalesID\",\n    \"3-0\": \"Signature\",\n    \"0-1\": \"Merchant Api Key generated in the MMS.\",\n    \"1-1\": \"Merchant Date and Time used to compose signature\",\n    \"2-1\": \"Reference Number of the merchant’s sale. Char(20)\",\n    \"3-1\": \"HASH SHA256 of:\\nRequestDateTime + \\nMerchantSalesID + SignatureKey\",\n    \"0-2\": \"String (32)\",\n    \"1-2\": \"Datetime\",\n    \"2-2\": \"String (50)\",\n    \"3-2\": \"String (64)\",\n    \"0-3\": \"Example:\\n23f1d7e1b2d44b7fb43e4bcddee45689\",\n    \"1-3\": \"ISO 8601: \\nyyyy-MM-ddThh:mm:ss\\n\\nExample: \\n2007-01-31T14:24:59\",\n    \"2-3\": \"Example: \\nORD-10001,\\nRXW-P03-V01,\\n001-012312220, etc.\",\n    \"3-3\": \"\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n**Request - Example** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<soapenv:Envelope xmlns:soapenv=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\" xmlns:urn=\\\"urn:safetypay:messages:mws:api\\\">\\n   <soapenv:Header/>\\n   <soapenv:Body>\\n      <urn:OperationRequest>\\n         <urn:ApiKey>d21f2476fb848d6974cd9b4ca615913a</urn:ApiKey>\\n         <urn:RequestDateTime>2016-04-25T16:54:05</urn:RequestDateTime>\\n         <urn:MerchantSalesID>13365</urn:MerchantSalesID>\\n         <urn:Signature>A13F184A8D21964C3290232437C934AA3FB55D0E759CB812F52F06FB9113366C</urn:Signature>\\n      </urn:OperationRequest>\\n   </soapenv:Body>\\n</soapenv:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n**Response Fields**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Values\",\n    \"0-0\": \"ResponseDateTime\",\n    \"1-0\": \"ListOfOperations\",\n    \"2-0\": \"Signature (*)\",\n    \"3-0\": \"ErrorManager\",\n    \"0-1\": \"SafetyPay Date and Time (GMT) used to compose the signature\",\n    \"1-1\": \"List of OperationType\",\n    \"2-1\": \"HASH SHA256 of:\\nResponseDateTime +\\nListOfOperations[n].OperationID + \\nListOfOperations[n].MerchantSalesID + \\nListOfOperations[n].OperationActivities[n]. CreationDateTime + \\nListOfOperations[n].OperationActivities[n].Status.StatusCode + \\nSignatureKey\",\n    \"3-1\": \"Error associated to the call\",\n    \"0-2\": \"Datetime\",\n    \"1-2\": \"ListOfOperationsType\",\n    \"2-2\": \"String (64)\",\n    \"3-2\": \"ErrorManagerType\",\n    \"0-3\": \"ISO 8601: \\nyyyy-MM-ddThh:mm:ss\\n\\nExample: \\n2007-01-31T14:24:59\",\n    \"1-3\": \"See defitnition of OperationType\",\n    \"2-3\": \"See Appendix B.\",\n    \"3-3\": \"See definition of ErrorManagerType\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n**Response - Example** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<s:Envelope xmlns:s=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\">\\n   <s:Body xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\">\\n      <OperationResponse xmlns=\\\"urn:safetypay:messages:mws:api\\\">\\n         <ResponseDateTime>2016-05-03T15:05:33</ResponseDateTime>\\n         <ListOfOperations>\\n            <Operation xmlns=\\\"urn:safetypay:schema:mws:api\\\">\\n               <CreationDateTime>2016-05-03T14:27:56</CreationDateTime>\\n               <OperationID>0116124116817117</OperationID>\\n               <MerchantSalesID>1234</MerchantSalesID>\\n               <MerchantOrderID>1234</MerchantOrderID>\\n               <Amount>2.0000</Amount>\\n               <CurrencyID>USD</CurrencyID>\\n               <ShopperAmount>11.0200</ShopperAmount>\\n               <ShopperCurrencyID>PEN</ShopperCurrencyID>\\n               <AuthorizationCode/>\\n               <OperationActivities>\\n                  <OperationActivity>\\n                     <CreationDateTime>2016-05-03T14:27:56</CreationDateTime>\\n                     <Status>\\n                        <StatusCode>101</StatusCode>\\n                        <Description>Purchase Pending</Description>\\n                     </Status>\\n                  </OperationActivity>\\n                  <OperationActivity>\\n                     <CreationDateTime>2016-05-03T14:30:41</CreationDateTime>\\n                     <Status>\\n                        <StatusCode>102</StatusCode>\\n                        <Description>Purchase Complete</Description>\\n                     </Status>\\n                 </OperationActivity>\\n                  <OperationActivity>\\n                     <CreationDateTime>2016-05-03T14:49:30</CreationDateTime>\\n                     <Status>\\n                        <StatusCode>104</StatusCode>\\n                        <Description>Notification Confirmed to merchant</Description>\\n                     </Status>\\n                  </OperationActivity>\\n               </OperationActivities>\\n               <PaymentReferenceNo/>\\n            </Operation>\\n         </ListOfOperations\\n        <Signature>F0804413102E62227F006C52C585410E5BED31F5D57EC530F5E1CC405524AB90</Signature>\\n         <ErrorManager>\\n            <ErrorNumber xmlns=\\\"urn:safetypay:schema:mws:api\\\">0</ErrorNumber>\\n         </ErrorManager>\\n      </OperationResponse>\\n   </s:Body>\\n</s:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"(*) ListOfOperations is an array of OperationType. The most important properties of an OperationType will be used to generate a Signature and guarantee the integrity of the information in the transportation process of the information from SAFETYPAY to the merchant\"\n}\n[/block]","excerpt":"","slug":"soap","type":"basic","title":"Integrating with SOAP API"}

Integrating with SOAP API


[block:callout] { "type": "info", "body": "Production Environment:\nhttps://mws2.safetypay.com/express/ws/v.3.0/\n\nSandbox Environment:\nhttps://sandbox-mws2.safetypay.com/express/ws/v.3.0/", "title": "Endpoints" } [/block] [block:api-header] { "type": "basic", "title": "GETOPERATION" } [/block] This method retrieves all operation activity for a specific operation. **Request Fields** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "h-2": "Type", "h-3": "Values", "0-0": "ApiKey", "1-0": "RequestDateTime", "2-0": "MerchantSalesID", "3-0": "Signature", "0-1": "Merchant Api Key generated in the MMS.", "1-1": "Merchant Date and Time used to compose signature", "2-1": "Reference Number of the merchant’s sale. Char(20)", "3-1": "HASH SHA256 of:\nRequestDateTime + \nMerchantSalesID + SignatureKey", "0-2": "String (32)", "1-2": "Datetime", "2-2": "String (50)", "3-2": "String (64)", "0-3": "Example:\n23f1d7e1b2d44b7fb43e4bcddee45689", "1-3": "ISO 8601: \nyyyy-MM-ddThh:mm:ss\n\nExample: \n2007-01-31T14:24:59", "2-3": "Example: \nORD-10001,\nRXW-P03-V01,\n001-012312220, etc.", "3-3": "" }, "cols": 4, "rows": 4 } [/block] **Request - Example** [block:code] { "codes": [ { "code": "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:urn=\"urn:safetypay:messages:mws:api\">\n <soapenv:Header/>\n <soapenv:Body>\n <urn:OperationRequest>\n <urn:ApiKey>d21f2476fb848d6974cd9b4ca615913a</urn:ApiKey>\n <urn:RequestDateTime>2016-04-25T16:54:05</urn:RequestDateTime>\n <urn:MerchantSalesID>13365</urn:MerchantSalesID>\n <urn:Signature>A13F184A8D21964C3290232437C934AA3FB55D0E759CB812F52F06FB9113366C</urn:Signature>\n </urn:OperationRequest>\n </soapenv:Body>\n</soapenv:Envelope>", "language": "xml" } ] } [/block] **Response Fields** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "h-2": "Type", "h-3": "Values", "0-0": "ResponseDateTime", "1-0": "ListOfOperations", "2-0": "Signature (*)", "3-0": "ErrorManager", "0-1": "SafetyPay Date and Time (GMT) used to compose the signature", "1-1": "List of OperationType", "2-1": "HASH SHA256 of:\nResponseDateTime +\nListOfOperations[n].OperationID + \nListOfOperations[n].MerchantSalesID + \nListOfOperations[n].OperationActivities[n]. CreationDateTime + \nListOfOperations[n].OperationActivities[n].Status.StatusCode + \nSignatureKey", "3-1": "Error associated to the call", "0-2": "Datetime", "1-2": "ListOfOperationsType", "2-2": "String (64)", "3-2": "ErrorManagerType", "0-3": "ISO 8601: \nyyyy-MM-ddThh:mm:ss\n\nExample: \n2007-01-31T14:24:59", "1-3": "See defitnition of OperationType", "2-3": "See Appendix B.", "3-3": "See definition of ErrorManagerType" }, "cols": 4, "rows": 4 } [/block] **Response - Example** [block:code] { "codes": [ { "code": "<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\n <s:Body xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">\n <OperationResponse xmlns=\"urn:safetypay:messages:mws:api\">\n <ResponseDateTime>2016-05-03T15:05:33</ResponseDateTime>\n <ListOfOperations>\n <Operation xmlns=\"urn:safetypay:schema:mws:api\">\n <CreationDateTime>2016-05-03T14:27:56</CreationDateTime>\n <OperationID>0116124116817117</OperationID>\n <MerchantSalesID>1234</MerchantSalesID>\n <MerchantOrderID>1234</MerchantOrderID>\n <Amount>2.0000</Amount>\n <CurrencyID>USD</CurrencyID>\n <ShopperAmount>11.0200</ShopperAmount>\n <ShopperCurrencyID>PEN</ShopperCurrencyID>\n <AuthorizationCode/>\n <OperationActivities>\n <OperationActivity>\n <CreationDateTime>2016-05-03T14:27:56</CreationDateTime>\n <Status>\n <StatusCode>101</StatusCode>\n <Description>Purchase Pending</Description>\n </Status>\n </OperationActivity>\n <OperationActivity>\n <CreationDateTime>2016-05-03T14:30:41</CreationDateTime>\n <Status>\n <StatusCode>102</StatusCode>\n <Description>Purchase Complete</Description>\n </Status>\n </OperationActivity>\n <OperationActivity>\n <CreationDateTime>2016-05-03T14:49:30</CreationDateTime>\n <Status>\n <StatusCode>104</StatusCode>\n <Description>Notification Confirmed to merchant</Description>\n </Status>\n </OperationActivity>\n </OperationActivities>\n <PaymentReferenceNo/>\n </Operation>\n </ListOfOperations\n <Signature>F0804413102E62227F006C52C585410E5BED31F5D57EC530F5E1CC405524AB90</Signature>\n <ErrorManager>\n <ErrorNumber xmlns=\"urn:safetypay:schema:mws:api\">0</ErrorNumber>\n </ErrorManager>\n </OperationResponse>\n </s:Body>\n</s:Envelope>", "language": "xml" } ] } [/block] [block:callout] { "type": "warning", "body": "(*) ListOfOperations is an array of OperationType. The most important properties of an OperationType will be used to generate a Signature and guarantee the integrity of the information in the transportation process of the information from SAFETYPAY to the merchant" } [/block]