ContractExchange

Click here for a complete list of operations.

GetPaymentData

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 /VPP/ContractExchange.asmx HTTP/1.1
Host: gmwstest.sppinc.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "SPP.net/ContractData/GetPaymentData"

<?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:Header>
    <AuthTokenHeader xmlns="SPP.net/ContractData">
      <Token>string</Token>
    </AuthTokenHeader>
  </soap:Header>
  <soap:Body>
    <GetPaymentData xmlns="SPP.net/ContractData">
      <ContractID>string</ContractID>
    </GetPaymentData>
  </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>
    <GetPaymentDataResponse xmlns="SPP.net/ContractData">
      <GetPaymentDataResult>boolean</GetPaymentDataResult>
      <payment>
        <NumberOfPayments>int</NumberOfPayments>
        <SalesTax>decimal</SalesTax>
        <Downpayment>decimal</Downpayment>
        <FirstPaymentDate>dateTime</FirstPaymentDate>
        <PaymentType>DirectDebit or CreditCard</PaymentType>
        <BankName>string</BankName>
        <DirectDebitAccountType>Unknown or Checking or Savings</DirectDebitAccountType>
        <DirectDebitRoutingNumber>string</DirectDebitRoutingNumber>
        <DirectDebitAccountNumber>string</DirectDebitAccountNumber>
        <CreditCardType>American Express or Discover or Master Card or VISA or Unknown</CreditCardType>
        <CreditCardNumber>string</CreditCardNumber>
        <CreditCardExpirationMonth>int</CreditCardExpirationMonth>
        <CreditCardExpirationYear>int</CreditCardExpirationYear>
        <AdminBatchNo>int</AdminBatchNo>
      </payment>
    </GetPaymentDataResponse>
  </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 /VPP/ContractExchange.asmx HTTP/1.1
Host: gmwstest.sppinc.net
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:Header>
    <AuthTokenHeader xmlns="SPP.net/ContractData">
      <Token>string</Token>
    </AuthTokenHeader>
  </soap12:Header>
  <soap12:Body>
    <GetPaymentData xmlns="SPP.net/ContractData">
      <ContractID>string</ContractID>
    </GetPaymentData>
  </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>
    <GetPaymentDataResponse xmlns="SPP.net/ContractData">
      <GetPaymentDataResult>boolean</GetPaymentDataResult>
      <payment>
        <NumberOfPayments>int</NumberOfPayments>
        <SalesTax>decimal</SalesTax>
        <Downpayment>decimal</Downpayment>
        <FirstPaymentDate>dateTime</FirstPaymentDate>
        <PaymentType>DirectDebit or CreditCard</PaymentType>
        <BankName>string</BankName>
        <DirectDebitAccountType>Unknown or Checking or Savings</DirectDebitAccountType>
        <DirectDebitRoutingNumber>string</DirectDebitRoutingNumber>
        <DirectDebitAccountNumber>string</DirectDebitAccountNumber>
        <CreditCardType>American Express or Discover or Master Card or VISA or Unknown</CreditCardType>
        <CreditCardNumber>string</CreditCardNumber>
        <CreditCardExpirationMonth>int</CreditCardExpirationMonth>
        <CreditCardExpirationYear>int</CreditCardExpirationYear>
        <AdminBatchNo>int</AdminBatchNo>
      </payment>
    </GetPaymentDataResponse>
  </soap12:Body>
</soap12:Envelope>