OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

Payment_TokenizedVerifyResponse_Adyen_V2

This method will verify the integrity of the information being returned, as a result of a payment request/result of Adyen Hosted Payment Pages. In this version Freedom will use the HMAC-256 algorithm (Payment_TokenizedVerifyResponse_Adyen method uses HMAC-SHA1) along with the HMAC secret key to calculate the correct signature of the SignatureString input parameter and will compare the result with MerchantSig input parameter. If those values match, this method will return a success response. If a mismatch is detected in these values, this method will return a HMAC_VALIDATION_FAILED message. If the TokenizedPaymentAccontID input parameter is NOT set, this method will use the entered online order # for assigning the correct tokenized payment account based on the Online Order Territory.
MerchantSignatureString parameter must follow Adyen's specification which is:
- Remove the following keys, as they are not used in the signature: a)sig b) merchantSig c) Any keys whose name starts with ignore. (dot included).
- Concatenate the key names, first; then, the key values.
- Use a colon (":") to delimit key names and key values.
- Escape embedded "\" characters as "\\", and embedded ":" as "\:".

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/Payment_TokenizedVerifyResponse_Adyen_V2"

<?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>
    <Payment_TokenizedVerifyResponse_Adyen_V2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <OnlineOrderID>int</OnlineOrderID>
        <MerchantSignatureString>string</MerchantSignatureString>
        <MerchantSig>string</MerchantSig>
        <TokenizedPaymentAccountID>int</TokenizedPaymentAccountID>
      </Request>
    </Payment_TokenizedVerifyResponse_Adyen_V2>
  </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>
    <Payment_TokenizedVerifyResponse_Adyen_V2Response xmlns="http://www.securefreedom.com/">
      <Payment_TokenizedVerifyResponse_Adyen_V2Result>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </Payment_TokenizedVerifyResponse_Adyen_V2Result>
    </Payment_TokenizedVerifyResponse_Adyen_V2Response>
  </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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.com
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>
    <Payment_TokenizedVerifyResponse_Adyen_V2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <OnlineOrderID>int</OnlineOrderID>
        <MerchantSignatureString>string</MerchantSignatureString>
        <MerchantSig>string</MerchantSig>
        <TokenizedPaymentAccountID>int</TokenizedPaymentAccountID>
      </Request>
    </Payment_TokenizedVerifyResponse_Adyen_V2>
  </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>
    <Payment_TokenizedVerifyResponse_Adyen_V2Response xmlns="http://www.securefreedom.com/">
      <Payment_TokenizedVerifyResponse_Adyen_V2Result>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </Payment_TokenizedVerifyResponse_Adyen_V2Result>
    </Payment_TokenizedVerifyResponse_Adyen_V2Response>
  </soap12:Body>
</soap12:Envelope>