Service Web Service

Service

Click here for a complete list of operations.

TransferTransactions

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 /Service.asmx HTTP/1.1
Host: webservice.k12paymentcenter.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservice.myschoolmoney.com/TransferTransactions"

<?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>
    <LPP_SoapHeader xmlns="http://webservice.myschoolmoney.com/">
      <Username>string</Username>
      <Password>string</Password>
    </LPP_SoapHeader>
  </soap:Header>
  <soap:Body>
    <TransferTransactions xmlns="http://webservice.myschoolmoney.com/">
      <District>int</District>
      <Command>Idle or SyncSites or SyncStudentInfo or InsertStudentInfo or UpdateStudentInfo or RequestParticipatingStudents or ProcessTransactionHistory or RequestTransactionsForIP or ProcessTransactionsForIPComplete or RequestAlaCarteExpense or ProcessAlaCarteExpenseComplete or ImportStudents or RequestLowBalanceRecurringPaymentStudents or ProcessLowBalanceRecurringPaymentStudents</Command>
      <Transactions>
        <LPP_Transaction>
          <Id>long</Id>
          <TIPId>int</TIPId>
          <StudentNumber>string</StudentNumber>
          <EffectiveDate>string</EffectiveDate>
          <EffectiveTime>string</EffectiveTime>
          <ItemId>string</ItemId>
          <SiteId>string</SiteId>
          <Description>string</Description>
          <Price>double</Price>
          <Quantity>int</Quantity>
          <VoidedDate>string</VoidedDate>
          <Balance>double</Balance>
          <VoidedCashierId>int</VoidedCashierId>
          <ExportedToLPP>string</ExportedToLPP>
          <TransferToPOS>string</TransferToPOS>
          <AmountPaid>double</AmountPaid>
          <ActualDT>dateTime</ActualDT>
          <ChargesPaid>double</ChargesPaid>
          <PrepayAmount>double</PrepayAmount>
          <TransferId>string</TransferId>
          <TransferDeniedId>int</TransferDeniedId>
        </LPP_Transaction>
        <LPP_Transaction>
          <Id>long</Id>
          <TIPId>int</TIPId>
          <StudentNumber>string</StudentNumber>
          <EffectiveDate>string</EffectiveDate>
          <EffectiveTime>string</EffectiveTime>
          <ItemId>string</ItemId>
          <SiteId>string</SiteId>
          <Description>string</Description>
          <Price>double</Price>
          <Quantity>int</Quantity>
          <VoidedDate>string</VoidedDate>
          <Balance>double</Balance>
          <VoidedCashierId>int</VoidedCashierId>
          <ExportedToLPP>string</ExportedToLPP>
          <TransferToPOS>string</TransferToPOS>
          <AmountPaid>double</AmountPaid>
          <ActualDT>dateTime</ActualDT>
          <ChargesPaid>double</ChargesPaid>
          <PrepayAmount>double</PrepayAmount>
          <TransferId>string</TransferId>
          <TransferDeniedId>int</TransferDeniedId>
        </LPP_Transaction>
      </Transactions>
    </TransferTransactions>
  </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>
    <TransferTransactionsResponse xmlns="http://webservice.myschoolmoney.com/">
      <TransferTransactionsResult>
        <LPP_Transaction>
          <Id>long</Id>
          <TIPId>int</TIPId>
          <StudentNumber>string</StudentNumber>
          <EffectiveDate>string</EffectiveDate>
          <EffectiveTime>string</EffectiveTime>
          <ItemId>string</ItemId>
          <SiteId>string</SiteId>
          <Description>string</Description>
          <Price>double</Price>
          <Quantity>int</Quantity>
          <VoidedDate>string</VoidedDate>
          <Balance>double</Balance>
          <VoidedCashierId>int</VoidedCashierId>
          <ExportedToLPP>string</ExportedToLPP>
          <TransferToPOS>string</TransferToPOS>
          <AmountPaid>double</AmountPaid>
          <ActualDT>dateTime</ActualDT>
          <ChargesPaid>double</ChargesPaid>
          <PrepayAmount>double</PrepayAmount>
          <TransferId>string</TransferId>
          <TransferDeniedId>int</TransferDeniedId>
        </LPP_Transaction>
        <LPP_Transaction>
          <Id>long</Id>
          <TIPId>int</TIPId>
          <StudentNumber>string</StudentNumber>
          <EffectiveDate>string</EffectiveDate>
          <EffectiveTime>string</EffectiveTime>
          <ItemId>string</ItemId>
          <SiteId>string</SiteId>
          <Description>string</Description>
          <Price>double</Price>
          <Quantity>int</Quantity>
          <VoidedDate>string</VoidedDate>
          <Balance>double</Balance>
          <VoidedCashierId>int</VoidedCashierId>
          <ExportedToLPP>string</ExportedToLPP>
          <TransferToPOS>string</TransferToPOS>
          <AmountPaid>double</AmountPaid>
          <ActualDT>dateTime</ActualDT>
          <ChargesPaid>double</ChargesPaid>
          <PrepayAmount>double</PrepayAmount>
          <TransferId>string</TransferId>
          <TransferDeniedId>int</TransferDeniedId>
        </LPP_Transaction>
      </TransferTransactionsResult>
    </TransferTransactionsResponse>
  </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 /Service.asmx HTTP/1.1
Host: webservice.k12paymentcenter.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:Header>
    <LPP_SoapHeader xmlns="http://webservice.myschoolmoney.com/">
      <Username>string</Username>
      <Password>string</Password>
    </LPP_SoapHeader>
  </soap12:Header>
  <soap12:Body>
    <TransferTransactions xmlns="http://webservice.myschoolmoney.com/">
      <District>int</District>
      <Command>Idle or SyncSites or SyncStudentInfo or InsertStudentInfo or UpdateStudentInfo or RequestParticipatingStudents or ProcessTransactionHistory or RequestTransactionsForIP or ProcessTransactionsForIPComplete or RequestAlaCarteExpense or ProcessAlaCarteExpenseComplete or ImportStudents or RequestLowBalanceRecurringPaymentStudents or ProcessLowBalanceRecurringPaymentStudents</Command>
      <Transactions>
        <LPP_Transaction>
          <Id>long</Id>
          <TIPId>int</TIPId>
          <StudentNumber>string</StudentNumber>
          <EffectiveDate>string</EffectiveDate>
          <EffectiveTime>string</EffectiveTime>
          <ItemId>string</ItemId>
          <SiteId>string</SiteId>
          <Description>string</Description>
          <Price>double</Price>
          <Quantity>int</Quantity>
          <VoidedDate>string</VoidedDate>
          <Balance>double</Balance>
          <VoidedCashierId>int</VoidedCashierId>
          <ExportedToLPP>string</ExportedToLPP>
          <TransferToPOS>string</TransferToPOS>
          <AmountPaid>double</AmountPaid>
          <ActualDT>dateTime</ActualDT>
          <ChargesPaid>double</ChargesPaid>
          <PrepayAmount>double</PrepayAmount>
          <TransferId>string</TransferId>
          <TransferDeniedId>int</TransferDeniedId>
        </LPP_Transaction>
        <LPP_Transaction>
          <Id>long</Id>
          <TIPId>int</TIPId>
          <StudentNumber>string</StudentNumber>
          <EffectiveDate>string</EffectiveDate>
          <EffectiveTime>string</EffectiveTime>
          <ItemId>string</ItemId>
          <SiteId>string</SiteId>
          <Description>string</Description>
          <Price>double</Price>
          <Quantity>int</Quantity>
          <VoidedDate>string</VoidedDate>
          <Balance>double</Balance>
          <VoidedCashierId>int</VoidedCashierId>
          <ExportedToLPP>string</ExportedToLPP>
          <TransferToPOS>string</TransferToPOS>
          <AmountPaid>double</AmountPaid>
          <ActualDT>dateTime</ActualDT>
          <ChargesPaid>double</ChargesPaid>
          <PrepayAmount>double</PrepayAmount>
          <TransferId>string</TransferId>
          <TransferDeniedId>int</TransferDeniedId>
        </LPP_Transaction>
      </Transactions>
    </TransferTransactions>
  </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>
    <TransferTransactionsResponse xmlns="http://webservice.myschoolmoney.com/">
      <TransferTransactionsResult>
        <LPP_Transaction>
          <Id>long</Id>
          <TIPId>int</TIPId>
          <StudentNumber>string</StudentNumber>
          <EffectiveDate>string</EffectiveDate>
          <EffectiveTime>string</EffectiveTime>
          <ItemId>string</ItemId>
          <SiteId>string</SiteId>
          <Description>string</Description>
          <Price>double</Price>
          <Quantity>int</Quantity>
          <VoidedDate>string</VoidedDate>
          <Balance>double</Balance>
          <VoidedCashierId>int</VoidedCashierId>
          <ExportedToLPP>string</ExportedToLPP>
          <TransferToPOS>string</TransferToPOS>
          <AmountPaid>double</AmountPaid>
          <ActualDT>dateTime</ActualDT>
          <ChargesPaid>double</ChargesPaid>
          <PrepayAmount>double</PrepayAmount>
          <TransferId>string</TransferId>
          <TransferDeniedId>int</TransferDeniedId>
        </LPP_Transaction>
        <LPP_Transaction>
          <Id>long</Id>
          <TIPId>int</TIPId>
          <StudentNumber>string</StudentNumber>
          <EffectiveDate>string</EffectiveDate>
          <EffectiveTime>string</EffectiveTime>
          <ItemId>string</ItemId>
          <SiteId>string</SiteId>
          <Description>string</Description>
          <Price>double</Price>
          <Quantity>int</Quantity>
          <VoidedDate>string</VoidedDate>
          <Balance>double</Balance>
          <VoidedCashierId>int</VoidedCashierId>
          <ExportedToLPP>string</ExportedToLPP>
          <TransferToPOS>string</TransferToPOS>
          <AmountPaid>double</AmountPaid>
          <ActualDT>dateTime</ActualDT>
          <ChargesPaid>double</ChargesPaid>
          <PrepayAmount>double</PrepayAmount>
          <TransferId>string</TransferId>
          <TransferDeniedId>int</TransferDeniedId>
        </LPP_Transaction>
      </TransferTransactionsResult>
    </TransferTransactionsResponse>
  </soap12:Body>
</soap12:Envelope>