OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

Payment_TokenizedRequest_Cybersource

This method will return the parameters needed to build the redirection form for CyberSource Secure Acceptance Web/Mobile. For using this method, a tokenized payment account using Cybersource as tokenized payment processor is required to be configured. If the TokenizedPaymentAccountID input parameter is NOT sent, this method will use the entered online order # for assigning the correct tokenized payment account based on the online order territory. Contact ByDesign Support for 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_TokenizedRequest_Cybersource"

<?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_TokenizedRequest_Cybersource xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <TokenizedPaymentAccountID>int</TokenizedPaymentAccountID>
        <OnlineOrderID>int</OnlineOrderID>
        <LocaleID>int</LocaleID>
      </Request>
    </Payment_TokenizedRequest_Cybersource>
  </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_TokenizedRequest_CybersourceResponse xmlns="http://www.securefreedom.com/">
      <Payment_TokenizedRequest_CybersourceResult>
        <AccessKey>string</AccessKey>
        <ProfileID>string</ProfileID>
        <TransactionUniqueID>string</TransactionUniqueID>
        <SignedFieldNames>string</SignedFieldNames>
        <UnsignedFieldNames>string</UnsignedFieldNames>
        <SignedDateTime>string</SignedDateTime>
        <Locale>string</Locale>
        <ReferenceNumber>string</ReferenceNumber>
        <TransactionType>string</TransactionType>
        <Currency>string</Currency>
        <Amount>string</Amount>
        <PaymentMethod>string</PaymentMethod>
        <CardType>string</CardType>
        <CardNumber>string</CardNumber>
        <CardExpiryDate>string</CardExpiryDate>
        <CardCVN>string</CardCVN>
        <BillToForename>string</BillToForename>
        <BillToSurename>string</BillToSurename>
        <BillToEmail>string</BillToEmail>
        <BillToLine1>string</BillToLine1>
        <BillToState>string</BillToState>
        <BillToCity>string</BillToCity>
        <BillToCountry>string</BillToCountry>
        <Signature>string</Signature>
      </Payment_TokenizedRequest_CybersourceResult>
    </Payment_TokenizedRequest_CybersourceResponse>
  </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_TokenizedRequest_Cybersource xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <TokenizedPaymentAccountID>int</TokenizedPaymentAccountID>
        <OnlineOrderID>int</OnlineOrderID>
        <LocaleID>int</LocaleID>
      </Request>
    </Payment_TokenizedRequest_Cybersource>
  </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_TokenizedRequest_CybersourceResponse xmlns="http://www.securefreedom.com/">
      <Payment_TokenizedRequest_CybersourceResult>
        <AccessKey>string</AccessKey>
        <ProfileID>string</ProfileID>
        <TransactionUniqueID>string</TransactionUniqueID>
        <SignedFieldNames>string</SignedFieldNames>
        <UnsignedFieldNames>string</UnsignedFieldNames>
        <SignedDateTime>string</SignedDateTime>
        <Locale>string</Locale>
        <ReferenceNumber>string</ReferenceNumber>
        <TransactionType>string</TransactionType>
        <Currency>string</Currency>
        <Amount>string</Amount>
        <PaymentMethod>string</PaymentMethod>
        <CardType>string</CardType>
        <CardNumber>string</CardNumber>
        <CardExpiryDate>string</CardExpiryDate>
        <CardCVN>string</CardCVN>
        <BillToForename>string</BillToForename>
        <BillToSurename>string</BillToSurename>
        <BillToEmail>string</BillToEmail>
        <BillToLine1>string</BillToLine1>
        <BillToState>string</BillToState>
        <BillToCity>string</BillToCity>
        <BillToCountry>string</BillToCountry>
        <Signature>string</Signature>
      </Payment_TokenizedRequest_CybersourceResult>
    </Payment_TokenizedRequest_CybersourceResponse>
  </soap12:Body>
</soap12:Envelope>