ContractExchange Web Service

ContractExchange

Click here for a complete list of operations.

SendContractData

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

<?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>
    <SendContractData xmlns="SPP.net/ContractData">
      <contract>
        <ContractID>string</ContractID>
        <AccountNumber>string</AccountNumber>
        <Status>Pending or Approved or Unwind or Archived</Status>
        <Company>string</Company>
        <ContractPrefix>string</ContractPrefix>
        <DealerCode>string</DealerCode>
        <FirstName>string</FirstName>
        <Mi>string</Mi>
        <LastName>string</LastName>
        <PhoneNumber>string</PhoneNumber>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <City>string</City>
        <StateProvinceAbbr />
        <ZipCode>string</ZipCode>
        <Country>USA or Canada</Country>
        <OriginatingDepartment>string</OriginatingDepartment>
        <Language>English or French</Language>
        <VIN>string</VIN>
        <PurchasePrice>decimal</PurchasePrice>
        <SalesTax>decimal</SalesTax>
        <DownPayment>decimal</DownPayment>
        <AmountFinanced>decimal</AmountFinanced>
        <PolicyType>ServiceContract or Maintenance or Lease</PolicyType>
        <InServiceDate>dateTime</InServiceDate>
        <FirstPaymentDate>dateTime</FirstPaymentDate>
        <DealerCost>decimal</DealerCost>
        <VSCPDF>base64Binary</VSCPDF>
        <ContractHoldersInitialsCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </ContractHoldersInitialsCoordinates>
        <ContractHoldersInitialsDateCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </ContractHoldersInitialsDateCoordinates>
        <ContractHoldersSignatureCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </ContractHoldersSignatureCoordinates>
        <SignatureDateCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </SignatureDateCoordinates>
        <SellersSignatureCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </SellersSignatureCoordinates>
        <PurchaseDate>dateTime</PurchaseDate>
        <BeginMileage>int</BeginMileage>
        <TermMonths>int</TermMonths>
        <TermMileage>int</TermMileage>
        <NumberOfPayments>1 or 3 or 6 or 11 or 12 or 15 or 17 or 18 or 24</NumberOfPayments>
        <SubContract>
          <SubContract>
            <SubAccountNumber>string</SubAccountNumber>
            <SubDealerCost>decimal</SubDealerCost>
            <SubOverRemit>decimal</SubOverRemit>
            <SubTermMonths>int</SubTermMonths>
            <SubTermMileage>int</SubTermMileage>
            <SubContractType>Mechanical or Maintenance or TireAndWheel</SubContractType>
            <SubContractName>string</SubContractName>
            <SubSalePrice>decimal</SubSalePrice>
            <SubSalesTax>decimal</SubSalesTax>
          </SubContract>
          <SubContract>
            <SubAccountNumber>string</SubAccountNumber>
            <SubDealerCost>decimal</SubDealerCost>
            <SubOverRemit>decimal</SubOverRemit>
            <SubTermMonths>int</SubTermMonths>
            <SubTermMileage>int</SubTermMileage>
            <SubContractType>Mechanical or Maintenance or TireAndWheel</SubContractType>
            <SubContractName>string</SubContractName>
            <SubSalePrice>decimal</SubSalePrice>
            <SubSalesTax>decimal</SubSalesTax>
          </SubContract>
        </SubContract>
        <CallBackURL>string</CallBackURL>
        <SerialNumber>string</SerialNumber>
      </contract>
    </SendContractData>
  </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>
    <SendContractDataResponse xmlns="SPP.net/ContractData">
      <SendContractDataResult>
        <responseCode>Unknown or Failure or Success or Incomplete</responseCode>
        <transactionID>long</transactionID>
        <ErrorCode>int</ErrorCode>
        <paymentLink>string</paymentLink>
        <paymenLinkExpirationDate>string</paymenLinkExpirationDate>
      </SendContractDataResult>
    </SendContractDataResponse>
  </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>
    <SendContractData xmlns="SPP.net/ContractData">
      <contract>
        <ContractID>string</ContractID>
        <AccountNumber>string</AccountNumber>
        <Status>Pending or Approved or Unwind or Archived</Status>
        <Company>string</Company>
        <ContractPrefix>string</ContractPrefix>
        <DealerCode>string</DealerCode>
        <FirstName>string</FirstName>
        <Mi>string</Mi>
        <LastName>string</LastName>
        <PhoneNumber>string</PhoneNumber>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <City>string</City>
        <StateProvinceAbbr />
        <ZipCode>string</ZipCode>
        <Country>USA or Canada</Country>
        <OriginatingDepartment>string</OriginatingDepartment>
        <Language>English or French</Language>
        <VIN>string</VIN>
        <PurchasePrice>decimal</PurchasePrice>
        <SalesTax>decimal</SalesTax>
        <DownPayment>decimal</DownPayment>
        <AmountFinanced>decimal</AmountFinanced>
        <PolicyType>ServiceContract or Maintenance or Lease</PolicyType>
        <InServiceDate>dateTime</InServiceDate>
        <FirstPaymentDate>dateTime</FirstPaymentDate>
        <DealerCost>decimal</DealerCost>
        <VSCPDF>base64Binary</VSCPDF>
        <ContractHoldersInitialsCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </ContractHoldersInitialsCoordinates>
        <ContractHoldersInitialsDateCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </ContractHoldersInitialsDateCoordinates>
        <ContractHoldersSignatureCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </ContractHoldersSignatureCoordinates>
        <SignatureDateCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </SignatureDateCoordinates>
        <SellersSignatureCoordinates>
          <xPosition>int</xPosition>
          <yPosition>int</yPosition>
        </SellersSignatureCoordinates>
        <PurchaseDate>dateTime</PurchaseDate>
        <BeginMileage>int</BeginMileage>
        <TermMonths>int</TermMonths>
        <TermMileage>int</TermMileage>
        <NumberOfPayments>1 or 3 or 6 or 11 or 12 or 15 or 17 or 18 or 24</NumberOfPayments>
        <SubContract>
          <SubContract>
            <SubAccountNumber>string</SubAccountNumber>
            <SubDealerCost>decimal</SubDealerCost>
            <SubOverRemit>decimal</SubOverRemit>
            <SubTermMonths>int</SubTermMonths>
            <SubTermMileage>int</SubTermMileage>
            <SubContractType>Mechanical or Maintenance or TireAndWheel</SubContractType>
            <SubContractName>string</SubContractName>
            <SubSalePrice>decimal</SubSalePrice>
            <SubSalesTax>decimal</SubSalesTax>
          </SubContract>
          <SubContract>
            <SubAccountNumber>string</SubAccountNumber>
            <SubDealerCost>decimal</SubDealerCost>
            <SubOverRemit>decimal</SubOverRemit>
            <SubTermMonths>int</SubTermMonths>
            <SubTermMileage>int</SubTermMileage>
            <SubContractType>Mechanical or Maintenance or TireAndWheel</SubContractType>
            <SubContractName>string</SubContractName>
            <SubSalePrice>decimal</SubSalePrice>
            <SubSalesTax>decimal</SubSalesTax>
          </SubContract>
        </SubContract>
        <CallBackURL>string</CallBackURL>
        <SerialNumber>string</SerialNumber>
      </contract>
    </SendContractData>
  </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>
    <SendContractDataResponse xmlns="SPP.net/ContractData">
      <SendContractDataResult>
        <responseCode>Unknown or Failure or Success or Incomplete</responseCode>
        <transactionID>long</transactionID>
        <ErrorCode>int</ErrorCode>
        <paymentLink>string</paymentLink>
        <paymenLinkExpirationDate>string</paymenLinkExpirationDate>
      </SendContractDataResult>
    </SendContractDataResponse>
  </soap12:Body>
</soap12:Envelope>