OnlineAPI


Click here for a complete list of operations.

ProcessGiftCard

For a given Online Order ID, one can transact a gift card payment using the GiftCardTransactionRequest request object.

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

<?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>
    <ProcessGiftCard xmlns="http://www.securefreedom.com/">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Token>string</Token>
        </Credentials>
        <GiftCardAccountID>int</GiftCardAccountID>
        <OrderID>int</OrderID>
        <OnlineOrderID>int</OnlineOrderID>
        <PartyID>int</PartyID>
        <Amount>decimal</Amount>
        <TransactionType>BALANCEINQUIRY or PROCESS</TransactionType>
        <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>
      </Request>
    </ProcessGiftCard>
  </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>
    <ProcessGiftCardResponse xmlns="http://www.securefreedom.com/">
      <ProcessGiftCardResult>
        <TransactionComplete>boolean</TransactionComplete>
        <Amount>decimal</Amount>
      </ProcessGiftCardResult>
    </ProcessGiftCardResponse>
  </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>
    <ProcessGiftCard xmlns="http://www.securefreedom.com/">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Token>string</Token>
        </Credentials>
        <GiftCardAccountID>int</GiftCardAccountID>
        <OrderID>int</OrderID>
        <OnlineOrderID>int</OnlineOrderID>
        <PartyID>int</PartyID>
        <Amount>decimal</Amount>
        <TransactionType>BALANCEINQUIRY or PROCESS</TransactionType>
        <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>
      </Request>
    </ProcessGiftCard>
  </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>
    <ProcessGiftCardResponse xmlns="http://www.securefreedom.com/">
      <ProcessGiftCardResult>
        <TransactionComplete>boolean</TransactionComplete>
        <Amount>decimal</Amount>
      </ProcessGiftCardResult>
    </ProcessGiftCardResponse>
  </soap12:Body>
</soap12:Envelope>