SmartPayService Web Service

SmartPayService

Click here for a complete list of operations.

RecordPayment

Records a manual payment. For legacy support only. Use the CreatePayment method instead.

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

<?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>
    <RecordPayment xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
      <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>xml</CustomerData>
        <NoCustomerEmail>boolean</NoCustomerEmail>
      </payment>
    </RecordPayment>
  </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>
    <RecordPaymentResponse xmlns="http://payments.onsharp.com/">
      <RecordPaymentResult>
        <TransactionId>int</TransactionId>
        <Status>int</Status>
        <Message>string</Message>
        <Errors>
          <ReturnError>
            <Code>int</Code>
            <IsSystemError>boolean</IsSystemError>
            <Message>string</Message>
          </ReturnError>
          <ReturnError>
            <Code>int</Code>
            <IsSystemError>boolean</IsSystemError>
            <Message>string</Message>
          </ReturnError>
        </Errors>
      </RecordPaymentResult>
    </RecordPaymentResponse>
  </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>
    <RecordPayment xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
      <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>xml</CustomerData>
        <NoCustomerEmail>boolean</NoCustomerEmail>
      </payment>
    </RecordPayment>
  </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>
    <RecordPaymentResponse xmlns="http://payments.onsharp.com/">
      <RecordPaymentResult>
        <TransactionId>int</TransactionId>
        <Status>int</Status>
        <Message>string</Message>
        <Errors>
          <ReturnError>
            <Code>int</Code>
            <IsSystemError>boolean</IsSystemError>
            <Message>string</Message>
          </ReturnError>
          <ReturnError>
            <Code>int</Code>
            <IsSystemError>boolean</IsSystemError>
            <Message>string</Message>
          </ReturnError>
        </Errors>
      </RecordPaymentResult>
    </RecordPaymentResponse>
  </soap12:Body>
</soap12:Envelope>