POS Web Service

POS

Click here for a complete list of operations.

PayItems

Post a payment to one or more payable items, returns the AIMS receipt number

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 /POS.asmx HTTP/1.1
Host: pvbflow.syrgov.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.edc-aim.com/schemas/passes_ws/PayItems"

<?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>
    <PayItems xmlns="http://www.edc-aim.com/schemas/passes_ws/">
      <payable_items>
        <ApiPayableItemInfo>
          <id>int</id>
          <ObjectType>TICKET or PERMIT or FEE or SKELETAL</ObjectType>
          <accountid>int</accountid>
          <Number>string</Number>
          <Code>string</Code>
          <Description>string</Description>
          <Date>dateTime</Date>
          <TaxAmount>decimal</TaxAmount>
          <TaxBalance>decimal</TaxBalance>
          <Amount>decimal</Amount>
          <Balance>decimal</Balance>
        </ApiPayableItemInfo>
        <ApiPayableItemInfo>
          <id>int</id>
          <ObjectType>TICKET or PERMIT or FEE or SKELETAL</ObjectType>
          <accountid>int</accountid>
          <Number>string</Number>
          <Code>string</Code>
          <Description>string</Description>
          <Date>dateTime</Date>
          <TaxAmount>decimal</TaxAmount>
          <TaxBalance>decimal</TaxBalance>
          <Amount>decimal</Amount>
          <Balance>decimal</Balance>
        </ApiPayableItemInfo>
      </payable_items>
      <payment_amount>decimal</payment_amount>
      <payment_date>dateTime</payment_date>
      <authorization_number>string</authorization_number>
      <payment_type_code>string</payment_type_code>
      <masked_cc_number>string</masked_cc_number>
      <check_number>string</check_number>
      <paid_via_code>string</paid_via_code>
      <user_name>string</user_name>
      <terminal_name>string</terminal_name>
    </PayItems>
  </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>
    <PayItemsResponse xmlns="http://www.edc-aim.com/schemas/passes_ws/">
      <PayItemsResult>string</PayItemsResult>
    </PayItemsResponse>
  </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 /POS.asmx HTTP/1.1
Host: pvbflow.syrgov.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:Body>
    <PayItems xmlns="http://www.edc-aim.com/schemas/passes_ws/">
      <payable_items>
        <ApiPayableItemInfo>
          <id>int</id>
          <ObjectType>TICKET or PERMIT or FEE or SKELETAL</ObjectType>
          <accountid>int</accountid>
          <Number>string</Number>
          <Code>string</Code>
          <Description>string</Description>
          <Date>dateTime</Date>
          <TaxAmount>decimal</TaxAmount>
          <TaxBalance>decimal</TaxBalance>
          <Amount>decimal</Amount>
          <Balance>decimal</Balance>
        </ApiPayableItemInfo>
        <ApiPayableItemInfo>
          <id>int</id>
          <ObjectType>TICKET or PERMIT or FEE or SKELETAL</ObjectType>
          <accountid>int</accountid>
          <Number>string</Number>
          <Code>string</Code>
          <Description>string</Description>
          <Date>dateTime</Date>
          <TaxAmount>decimal</TaxAmount>
          <TaxBalance>decimal</TaxBalance>
          <Amount>decimal</Amount>
          <Balance>decimal</Balance>
        </ApiPayableItemInfo>
      </payable_items>
      <payment_amount>decimal</payment_amount>
      <payment_date>dateTime</payment_date>
      <authorization_number>string</authorization_number>
      <payment_type_code>string</payment_type_code>
      <masked_cc_number>string</masked_cc_number>
      <check_number>string</check_number>
      <paid_via_code>string</paid_via_code>
      <user_name>string</user_name>
      <terminal_name>string</terminal_name>
    </PayItems>
  </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>
    <PayItemsResponse xmlns="http://www.edc-aim.com/schemas/passes_ws/">
      <PayItemsResult>string</PayItemsResult>
    </PayItemsResponse>
  </soap12:Body>
</soap12:Envelope>