CompraFacilWS


Click here for a complete list of operations.

getReferencePS2

Get a new PAYSHOP reference for payment specifying a product ID stored in CompraFacil.This method internally calculates the amount payable according to the quantity of specified item and returns the value in variable amountOut.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /SIBSClick2/webservice/comprafacilWS.asmx HTTP/1.1
Host: hm.comprafacil.pt
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.comprafacil.pt/getReferencePS2"

<?xml version="1.0" encoding="utf-8"?>
<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>
    <getReferencePS2 xmlns="http://www.comprafacil.pt/">
      <origin>string</origin>
      <productID>string</productID>
      <username>string</username>
      <password>string</password>
      <quantity>int</quantity>
      <additionalInfo>string</additionalInfo>
      <name>string</name>
      <address>string</address>
      <postCode>string</postCode>
      <city>string</city>
      <NIC>string</NIC>
      <externalReference>string</externalReference>
      <contactPhone>string</contactPhone>
      <email>string</email>
      <IDUserBackoffice>int</IDUserBackoffice>
      <sendEmailBuyer>boolean</sendEmailBuyer>
    </getReferencePS2>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<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>
    <getReferencePS2Response xmlns="http://www.comprafacil.pt/">
      <getReferencePS2Result>boolean</getReferencePS2Result>
      <reference>string</reference>
      <paymentDeadline>string</paymentDeadline>
      <valor>decimal</valor>
      <error>string</error>
    </getReferencePS2Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /SIBSClick2/webservice/comprafacilWS.asmx HTTP/1.1
Host: hm.comprafacil.pt
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getReferencePS2 xmlns="http://www.comprafacil.pt/">
      <origin>string</origin>
      <productID>string</productID>
      <username>string</username>
      <password>string</password>
      <quantity>int</quantity>
      <additionalInfo>string</additionalInfo>
      <name>string</name>
      <address>string</address>
      <postCode>string</postCode>
      <city>string</city>
      <NIC>string</NIC>
      <externalReference>string</externalReference>
      <contactPhone>string</contactPhone>
      <email>string</email>
      <IDUserBackoffice>int</IDUserBackoffice>
      <sendEmailBuyer>boolean</sendEmailBuyer>
    </getReferencePS2>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getReferencePS2Response xmlns="http://www.comprafacil.pt/">
      <getReferencePS2Result>boolean</getReferencePS2Result>
      <reference>string</reference>
      <paymentDeadline>string</paymentDeadline>
      <valor>decimal</valor>
      <error>string</error>
    </getReferencePS2Response>
  </soap12:Body>
</soap12:Envelope>