CompraFacilWS


Click here for a complete list of operations.

getReferenceMB2

Get a new MULTIBANCO 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. The parameter timeLimitDays specifies the total number of days that a reference is payable. If this entity doesn't support this feature, this value is ignored.

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/getReferenceMB2"

<?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>
    <getReferenceMB2 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>
      <timeLimitDays>int</timeLimitDays>
      <sendEmailBuyer>boolean</sendEmailBuyer>
    </getReferenceMB2>
  </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>
    <getReferenceMB2Response xmlns="http://www.comprafacil.pt/">
      <getReferenceMB2Result>boolean</getReferenceMB2Result>
      <reference>string</reference>
      <entity>string</entity>
      <amountOut>decimal</amountOut>
      <error>string</error>
    </getReferenceMB2Response>
  </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>
    <getReferenceMB2 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>
      <timeLimitDays>int</timeLimitDays>
      <sendEmailBuyer>boolean</sendEmailBuyer>
    </getReferenceMB2>
  </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>
    <getReferenceMB2Response xmlns="http://www.comprafacil.pt/">
      <getReferenceMB2Result>boolean</getReferenceMB2Result>
      <reference>string</reference>
      <entity>string</entity>
      <amountOut>decimal</amountOut>
      <error>string</error>
    </getReferenceMB2Response>
  </soap12:Body>
</soap12:Envelope>