AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SelectPaymentsInfoByPaymentsID

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 /AxWCC1474WS/AchademixWS.asmx HTTP/1.1
Host: wcccws.achademix.info
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.Achademix.com/SelectPaymentsInfoByPaymentsID"

<?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>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap:Header>
  <soap:Body>
    <SelectPaymentsInfoByPaymentsID xmlns="http://www.Achademix.com/">
      <PaymentsID>int</PaymentsID>
    </SelectPaymentsInfoByPaymentsID>
  </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:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap:Header>
  <soap:Body>
    <SelectPaymentsInfoByPaymentsIDResponse xmlns="http://www.Achademix.com/">
      <SelectPaymentsInfoByPaymentsIDResult>
        <AwardDueDate>dateTime</AwardDueDate>
        <BatchCode>string</BatchCode>
        <SetAccountStatus>int</SetAccountStatus>
        <TransferFromAccount>int</TransferFromAccount>
        <Allocations>
          <Allocation>
            <Payment xsi:nil="true" />
            <RefundAmount>decimal</RefundAmount>
            <RefundedAmount>decimal</RefundedAmount>
            <Sale xsi:nil="true" />
            <Ticket xsi:nil="true" />
            <PayReference>string</PayReference>
            <ReceiptNumber>string</ReceiptNumber>
            <Amount>decimal</Amount>
            <AllocationID>int</AllocationID>
            <PaymentsID>int</PaymentsID>
            <SalesID>int</SalesID>
            <ImportKey>int</ImportKey>
          </Allocation>
          <Allocation>
            <Payment xsi:nil="true" />
            <RefundAmount>decimal</RefundAmount>
            <RefundedAmount>decimal</RefundedAmount>
            <Sale xsi:nil="true" />
            <Ticket xsi:nil="true" />
            <PayReference>string</PayReference>
            <ReceiptNumber>string</ReceiptNumber>
            <Amount>decimal</Amount>
            <AllocationID>int</AllocationID>
            <PaymentsID>int</PaymentsID>
            <SalesID>int</SalesID>
            <ImportKey>int</ImportKey>
          </Allocation>
        </Allocations>
        <BatchNum>int</BatchNum>
        <CardTitle>string</CardTitle>
        <Refunds>
          <Refund>
            <Approved>boolean</Approved>
            <BatchRequest>boolean</BatchRequest>
            <Name>string</Name>
            <Released>boolean</Released>
            <RefAllAmount>decimal</RefAllAmount>
            <AllocationID>int</AllocationID>
            <Allocations xsi:nil="true" />
            <RefundTitle>string</RefundTitle>
            <UserAccountID>int</UserAccountID>
            <VendorCode>string</VendorCode>
            <ApprovedDate>dateTime</ApprovedDate>
            <ApprovedUser>int</ApprovedUser>
            <CompleteDate>dateTime</CompleteDate>
            <CompleteUser>int</CompleteUser>
            <Note>string</Note>
            <ReleaseDate>dateTime</ReleaseDate>
            <ReleaseUser>int</ReleaseUser>
            <CheckNum>string</CheckNum>
            <RefAmount>decimal</RefAmount>
            <PaymentsID>int</PaymentsID>
            <RefSent>boolean</RefSent>
            <RefundID>int</RefundID>
          </Refund>
          <Refund>
            <Approved>boolean</Approved>
            <BatchRequest>boolean</BatchRequest>
            <Name>string</Name>
            <Released>boolean</Released>
            <RefAllAmount>decimal</RefAllAmount>
            <AllocationID>int</AllocationID>
            <Allocations xsi:nil="true" />
            <RefundTitle>string</RefundTitle>
            <UserAccountID>int</UserAccountID>
            <VendorCode>string</VendorCode>
            <ApprovedDate>dateTime</ApprovedDate>
            <ApprovedUser>int</ApprovedUser>
            <CompleteDate>dateTime</CompleteDate>
            <CompleteUser>int</CompleteUser>
            <Note>string</Note>
            <ReleaseDate>dateTime</ReleaseDate>
            <ReleaseUser>int</ReleaseUser>
            <CheckNum>string</CheckNum>
            <RefAmount>decimal</RefAmount>
            <PaymentsID>int</PaymentsID>
            <RefSent>boolean</RefSent>
            <RefundID>int</RefundID>
          </Refund>
        </Refunds>
        <TrmImportKey>int</TrmImportKey>
        <TypeTitle>string</TypeTitle>
        <AccountAddress>string</AccountAddress>
        <CCHolder>string</CCHolder>
        <CreditCardListID>int</CreditCardListID>
        <DistributionID>int</DistributionID>
        <PayAmount>decimal</PayAmount>
        <CCExpire>string</CCExpire>
        <CCNumber>string</CCNumber>
        <CheckNumber>string</CheckNumber>
        <IsAllocated>boolean</IsAllocated>
        <PaymentsID>int</PaymentsID>
        <Note>string</Note>
        <Reference>string</Reference>
        <PayTypeID>int</PayTypeID>
        <PrintCount>int</PrintCount>
        <ZoutID>int</ZoutID>
        <ReceiptNumber>string</ReceiptNumber>
      </SelectPaymentsInfoByPaymentsIDResult>
    </SelectPaymentsInfoByPaymentsIDResponse>
  </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 /AxWCC1474WS/AchademixWS.asmx HTTP/1.1
Host: wcccws.achademix.info
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>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap12:Header>
  <soap12:Body>
    <SelectPaymentsInfoByPaymentsID xmlns="http://www.Achademix.com/">
      <PaymentsID>int</PaymentsID>
    </SelectPaymentsInfoByPaymentsID>
  </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:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap12:Header>
  <soap12:Body>
    <SelectPaymentsInfoByPaymentsIDResponse xmlns="http://www.Achademix.com/">
      <SelectPaymentsInfoByPaymentsIDResult>
        <AwardDueDate>dateTime</AwardDueDate>
        <BatchCode>string</BatchCode>
        <SetAccountStatus>int</SetAccountStatus>
        <TransferFromAccount>int</TransferFromAccount>
        <Allocations>
          <Allocation>
            <Payment xsi:nil="true" />
            <RefundAmount>decimal</RefundAmount>
            <RefundedAmount>decimal</RefundedAmount>
            <Sale xsi:nil="true" />
            <Ticket xsi:nil="true" />
            <PayReference>string</PayReference>
            <ReceiptNumber>string</ReceiptNumber>
            <Amount>decimal</Amount>
            <AllocationID>int</AllocationID>
            <PaymentsID>int</PaymentsID>
            <SalesID>int</SalesID>
            <ImportKey>int</ImportKey>
          </Allocation>
          <Allocation>
            <Payment xsi:nil="true" />
            <RefundAmount>decimal</RefundAmount>
            <RefundedAmount>decimal</RefundedAmount>
            <Sale xsi:nil="true" />
            <Ticket xsi:nil="true" />
            <PayReference>string</PayReference>
            <ReceiptNumber>string</ReceiptNumber>
            <Amount>decimal</Amount>
            <AllocationID>int</AllocationID>
            <PaymentsID>int</PaymentsID>
            <SalesID>int</SalesID>
            <ImportKey>int</ImportKey>
          </Allocation>
        </Allocations>
        <BatchNum>int</BatchNum>
        <CardTitle>string</CardTitle>
        <Refunds>
          <Refund>
            <Approved>boolean</Approved>
            <BatchRequest>boolean</BatchRequest>
            <Name>string</Name>
            <Released>boolean</Released>
            <RefAllAmount>decimal</RefAllAmount>
            <AllocationID>int</AllocationID>
            <Allocations xsi:nil="true" />
            <RefundTitle>string</RefundTitle>
            <UserAccountID>int</UserAccountID>
            <VendorCode>string</VendorCode>
            <ApprovedDate>dateTime</ApprovedDate>
            <ApprovedUser>int</ApprovedUser>
            <CompleteDate>dateTime</CompleteDate>
            <CompleteUser>int</CompleteUser>
            <Note>string</Note>
            <ReleaseDate>dateTime</ReleaseDate>
            <ReleaseUser>int</ReleaseUser>
            <CheckNum>string</CheckNum>
            <RefAmount>decimal</RefAmount>
            <PaymentsID>int</PaymentsID>
            <RefSent>boolean</RefSent>
            <RefundID>int</RefundID>
          </Refund>
          <Refund>
            <Approved>boolean</Approved>
            <BatchRequest>boolean</BatchRequest>
            <Name>string</Name>
            <Released>boolean</Released>
            <RefAllAmount>decimal</RefAllAmount>
            <AllocationID>int</AllocationID>
            <Allocations xsi:nil="true" />
            <RefundTitle>string</RefundTitle>
            <UserAccountID>int</UserAccountID>
            <VendorCode>string</VendorCode>
            <ApprovedDate>dateTime</ApprovedDate>
            <ApprovedUser>int</ApprovedUser>
            <CompleteDate>dateTime</CompleteDate>
            <CompleteUser>int</CompleteUser>
            <Note>string</Note>
            <ReleaseDate>dateTime</ReleaseDate>
            <ReleaseUser>int</ReleaseUser>
            <CheckNum>string</CheckNum>
            <RefAmount>decimal</RefAmount>
            <PaymentsID>int</PaymentsID>
            <RefSent>boolean</RefSent>
            <RefundID>int</RefundID>
          </Refund>
        </Refunds>
        <TrmImportKey>int</TrmImportKey>
        <TypeTitle>string</TypeTitle>
        <AccountAddress>string</AccountAddress>
        <CCHolder>string</CCHolder>
        <CreditCardListID>int</CreditCardListID>
        <DistributionID>int</DistributionID>
        <PayAmount>decimal</PayAmount>
        <CCExpire>string</CCExpire>
        <CCNumber>string</CCNumber>
        <CheckNumber>string</CheckNumber>
        <IsAllocated>boolean</IsAllocated>
        <PaymentsID>int</PaymentsID>
        <Note>string</Note>
        <Reference>string</Reference>
        <PayTypeID>int</PayTypeID>
        <PrintCount>int</PrintCount>
        <ZoutID>int</ZoutID>
        <ReceiptNumber>string</ReceiptNumber>
      </SelectPaymentsInfoByPaymentsIDResult>
    </SelectPaymentsInfoByPaymentsIDResponse>
  </soap12:Body>
</soap12:Envelope>