SmartPayService Web Service

SmartPayService

Click here for a complete list of operations.

GetAndMarkSubmittedPayments

Gets the list of current payments that have not been marked as exported and marks them as being exported so that they are not included in future requests. Optionally only retrieves the (non-exported) payments created between the specified dates.

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 /SmartPayService.asmx HTTP/1.1
Host: apipayments.infinitytms.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://payments.onsharp.com/GetAndMarkSubmittedPayments"

<?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>
    <GetAndMarkSubmittedPayments xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
      <start>dateTime</start>
      <end>dateTime</end>
    </GetAndMarkSubmittedPayments>
  </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>
    <GetAndMarkSubmittedPaymentsResponse xmlns="http://payments.onsharp.com/">
      <GetAndMarkSubmittedPaymentsResult>
        <Payments>
          <Payment>
            <Id>string</Id>
            <BatchId>string</BatchId>
            <MethodTypeId>int</MethodTypeId>
            <MethodTypeName>string</MethodTypeName>
            <CheckNumber>int</CheckNumber>
            <AccountId>guid</AccountId>
            <AccountName>string</AccountName>
            <AccountLast4>string</AccountLast4>
            <InvoiceNumber>string</InvoiceNumber>
            <DatePaid>dateTime</DatePaid>
            <AmountPaid>decimal</AmountPaid>
            <ConfirmationNumber>string</ConfirmationNumber>
            <Description>string</Description>
            <ProcessDate>dateTime</ProcessDate>
            <CustomerId>string</CustomerId>
            <CustomerName>string</CustomerName>
            <CustomerEmail>string</CustomerEmail>
            <CustomerPhone>string</CustomerPhone>
            <CustomerData xsi:nil="true" />
            <NoCustomerEmail>boolean</NoCustomerEmail>
          </Payment>
          <Payment>
            <Id>string</Id>
            <BatchId>string</BatchId>
            <MethodTypeId>int</MethodTypeId>
            <MethodTypeName>string</MethodTypeName>
            <CheckNumber>int</CheckNumber>
            <AccountId>guid</AccountId>
            <AccountName>string</AccountName>
            <AccountLast4>string</AccountLast4>
            <InvoiceNumber>string</InvoiceNumber>
            <DatePaid>dateTime</DatePaid>
            <AmountPaid>decimal</AmountPaid>
            <ConfirmationNumber>string</ConfirmationNumber>
            <Description>string</Description>
            <ProcessDate>dateTime</ProcessDate>
            <CustomerId>string</CustomerId>
            <CustomerName>string</CustomerName>
            <CustomerEmail>string</CustomerEmail>
            <CustomerPhone>string</CustomerPhone>
            <CustomerData xsi:nil="true" />
            <NoCustomerEmail>boolean</NoCustomerEmail>
          </Payment>
        </Payments>
        <Surcharges>
          <Surcharge>
            <GatewayReferenceId>string</GatewayReferenceId>
            <Amount>decimal</Amount>
          </Surcharge>
          <Surcharge>
            <GatewayReferenceId>string</GatewayReferenceId>
            <Amount>decimal</Amount>
          </Surcharge>
        </Surcharges>
      </GetAndMarkSubmittedPaymentsResult>
    </GetAndMarkSubmittedPaymentsResponse>
  </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 /SmartPayService.asmx HTTP/1.1
Host: apipayments.infinitytms.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:Body>
    <GetAndMarkSubmittedPayments xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
      <start>dateTime</start>
      <end>dateTime</end>
    </GetAndMarkSubmittedPayments>
  </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>
    <GetAndMarkSubmittedPaymentsResponse xmlns="http://payments.onsharp.com/">
      <GetAndMarkSubmittedPaymentsResult>
        <Payments>
          <Payment>
            <Id>string</Id>
            <BatchId>string</BatchId>
            <MethodTypeId>int</MethodTypeId>
            <MethodTypeName>string</MethodTypeName>
            <CheckNumber>int</CheckNumber>
            <AccountId>guid</AccountId>
            <AccountName>string</AccountName>
            <AccountLast4>string</AccountLast4>
            <InvoiceNumber>string</InvoiceNumber>
            <DatePaid>dateTime</DatePaid>
            <AmountPaid>decimal</AmountPaid>
            <ConfirmationNumber>string</ConfirmationNumber>
            <Description>string</Description>
            <ProcessDate>dateTime</ProcessDate>
            <CustomerId>string</CustomerId>
            <CustomerName>string</CustomerName>
            <CustomerEmail>string</CustomerEmail>
            <CustomerPhone>string</CustomerPhone>
            <CustomerData xsi:nil="true" />
            <NoCustomerEmail>boolean</NoCustomerEmail>
          </Payment>
          <Payment>
            <Id>string</Id>
            <BatchId>string</BatchId>
            <MethodTypeId>int</MethodTypeId>
            <MethodTypeName>string</MethodTypeName>
            <CheckNumber>int</CheckNumber>
            <AccountId>guid</AccountId>
            <AccountName>string</AccountName>
            <AccountLast4>string</AccountLast4>
            <InvoiceNumber>string</InvoiceNumber>
            <DatePaid>dateTime</DatePaid>
            <AmountPaid>decimal</AmountPaid>
            <ConfirmationNumber>string</ConfirmationNumber>
            <Description>string</Description>
            <ProcessDate>dateTime</ProcessDate>
            <CustomerId>string</CustomerId>
            <CustomerName>string</CustomerName>
            <CustomerEmail>string</CustomerEmail>
            <CustomerPhone>string</CustomerPhone>
            <CustomerData xsi:nil="true" />
            <NoCustomerEmail>boolean</NoCustomerEmail>
          </Payment>
        </Payments>
        <Surcharges>
          <Surcharge>
            <GatewayReferenceId>string</GatewayReferenceId>
            <Amount>decimal</Amount>
          </Surcharge>
          <Surcharge>
            <GatewayReferenceId>string</GatewayReferenceId>
            <Amount>decimal</Amount>
          </Surcharge>
        </Surcharges>
      </GetAndMarkSubmittedPaymentsResult>
    </GetAndMarkSubmittedPaymentsResponse>
  </soap12:Body>
</soap12:Envelope>