OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

Payment_CheckDraft

This method allows one to submit a check draft payment for a given online order id and check draft information.

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

<?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_CheckDraft xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
      <PaymentInfo>
        <AccountName>string</AccountName>
        <AccountAddr1>string</AccountAddr1>
        <AccountAddr2>string</AccountAddr2>
        <BankName>string</BankName>
        <AccountNumber>string</AccountNumber>
        <RoutingNumber>string</RoutingNumber>
        <CheckNumber>int</CheckNumber>
        <Amount>double</Amount>
      </PaymentInfo>
    </Payment_CheckDraft>
  </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_CheckDraftResponse xmlns="http://www.securefreedom.com/">
      <Payment_CheckDraftResult>int</Payment_CheckDraftResult>
    </Payment_CheckDraftResponse>
  </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_CheckDraft xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
      <PaymentInfo>
        <AccountName>string</AccountName>
        <AccountAddr1>string</AccountAddr1>
        <AccountAddr2>string</AccountAddr2>
        <BankName>string</BankName>
        <AccountNumber>string</AccountNumber>
        <RoutingNumber>string</RoutingNumber>
        <CheckNumber>int</CheckNumber>
        <Amount>double</Amount>
      </PaymentInfo>
    </Payment_CheckDraft>
  </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_CheckDraftResponse xmlns="http://www.securefreedom.com/">
      <Payment_CheckDraftResult>int</Payment_CheckDraftResult>
    </Payment_CheckDraftResponse>
  </soap12:Body>
</soap12:Envelope>