OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

Payment_CreditCard

This method allows one to add a payment for a given online order id. Note: If testing is true, the payment will be added, but no transaction will be made with the processor. As long as the card passes the MOD2 test, the payment will transact successfully.

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_CreditCard"

<?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_CreditCard xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <TestMode>int</TestMode>
      <OnlineOrderID>int</OnlineOrderID>
      <PaymentInfo>
        <FirstNameOnCard>string</FirstNameOnCard>
        <LastNameOnCard>string</LastNameOnCard>
        <Address>string</Address>
        <ZipCode>string</ZipCode>
        <ExpDateMonth>string</ExpDateMonth>
        <ExpDateYear>string</ExpDateYear>
        <CVV>string</CVV>
        <CVV2>string</CVV2>
        <CreditCardNumber>string</CreditCardNumber>
        <Amount>double</Amount>
      </PaymentInfo>
    </Payment_CreditCard>
  </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_CreditCardResponse xmlns="http://www.securefreedom.com/">
      <Payment_CreditCardResult>
        <TransactionCompleted>boolean</TransactionCompleted>
        <Description>string</Description>
        <AuthCode>string</AuthCode>
        <Amount>double</Amount>
      </Payment_CreditCardResult>
    </Payment_CreditCardResponse>
  </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_CreditCard xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <TestMode>int</TestMode>
      <OnlineOrderID>int</OnlineOrderID>
      <PaymentInfo>
        <FirstNameOnCard>string</FirstNameOnCard>
        <LastNameOnCard>string</LastNameOnCard>
        <Address>string</Address>
        <ZipCode>string</ZipCode>
        <ExpDateMonth>string</ExpDateMonth>
        <ExpDateYear>string</ExpDateYear>
        <CVV>string</CVV>
        <CVV2>string</CVV2>
        <CreditCardNumber>string</CreditCardNumber>
        <Amount>double</Amount>
      </PaymentInfo>
    </Payment_CreditCard>
  </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_CreditCardResponse xmlns="http://www.securefreedom.com/">
      <Payment_CreditCardResult>
        <TransactionCompleted>boolean</TransactionCompleted>
        <Description>string</Description>
        <AuthCode>string</AuthCode>
        <Amount>double</Amount>
      </Payment_CreditCardResult>
    </Payment_CreditCardResponse>
  </soap12:Body>
</soap12:Envelope>