OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

Payment_TokenizedStore

This method allows adding a tokenized payment to an online order. Unlike Payment_Tokenized method, this one only stores the payment information into the online order without processing a new recurring payment from Freedom to the tokenized processor. Use this method when you generated a payment using a tokenized processor in your own shopping cart and you want to store the payment authorization to the online order. For using this method you will need to configure a tokenized payment account. If the TokenizedPaymentAccountID 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. Contact ByDesign Support to know the correct payment details to use based on the tokenized processor configured in Freedom.

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.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/Payment_TokenizedStore"

<?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_TokenizedStore xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
      <PaymentInfo>
        <Amount>double</Amount>
        <PaymentDetails>
          <Detail1>string</Detail1>
          <Detail2>string</Detail2>
          <Detail3>string</Detail3>
          <Detail4>string</Detail4>
          <Detail5>string</Detail5>
          <Detail6>string</Detail6>
          <Detail7>string</Detail7>
          <Detail8>string</Detail8>
          <Detail9>string</Detail9>
          <Detail10>string</Detail10>
          <Detail11>string</Detail11>
          <Detail12>string</Detail12>
          <Detail13>string</Detail13>
          <Detail14>string</Detail14>
          <Detail15>string</Detail15>
          <Detail16>string</Detail16>
          <Detail17>string</Detail17>
          <Detail18>string</Detail18>
          <Detail19>string</Detail19>
        </PaymentDetails>
      </PaymentInfo>
      <TokenizedPaymentAccountID>int</TokenizedPaymentAccountID>
    </Payment_TokenizedStore>
  </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_TokenizedStoreResponse xmlns="http://www.securefreedom.com/">
      <Payment_TokenizedStoreResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </Payment_TokenizedStoreResult>
    </Payment_TokenizedStoreResponse>
  </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.bydesign.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_TokenizedStore xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
      <PaymentInfo>
        <Amount>double</Amount>
        <PaymentDetails>
          <Detail1>string</Detail1>
          <Detail2>string</Detail2>
          <Detail3>string</Detail3>
          <Detail4>string</Detail4>
          <Detail5>string</Detail5>
          <Detail6>string</Detail6>
          <Detail7>string</Detail7>
          <Detail8>string</Detail8>
          <Detail9>string</Detail9>
          <Detail10>string</Detail10>
          <Detail11>string</Detail11>
          <Detail12>string</Detail12>
          <Detail13>string</Detail13>
          <Detail14>string</Detail14>
          <Detail15>string</Detail15>
          <Detail16>string</Detail16>
          <Detail17>string</Detail17>
          <Detail18>string</Detail18>
          <Detail19>string</Detail19>
        </PaymentDetails>
      </PaymentInfo>
      <TokenizedPaymentAccountID>int</TokenizedPaymentAccountID>
    </Payment_TokenizedStore>
  </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_TokenizedStoreResponse xmlns="http://www.securefreedom.com/">
      <Payment_TokenizedStoreResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </Payment_TokenizedStoreResult>
    </Payment_TokenizedStoreResponse>
  </soap12:Body>
</soap12:Envelope>