SmartPayService Web Service

SmartPayService

Click here for a complete list of operations.

AddInvoiceTemplate

Creates a new invoice template in the system.

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

<?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>
    <AddInvoiceTemplate xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
      <template>
        <TemplateName>string</TemplateName>
        <Description>string</Description>
        <Amount>decimal</Amount>
        <DueDateInterval>short</DueDateInterval>
        <CustomerId>string</CustomerId>
        <NotifyCustomer>boolean</NotifyCustomer>
        <NotifyMerchant>boolean</NotifyMerchant>
        <IsDeleted>boolean</IsDeleted>
        <DayOfMonth>unsignedByte</DayOfMonth>
        <DayOfWeek>unsignedByte</DayOfWeek>
        <EndCondition>unsignedByte</EndCondition>
        <EndDate>dateTime</EndDate>
        <EndTimes>int</EndTimes>
        <IntervalDays>int</IntervalDays>
        <IntervalType>unsignedByte</IntervalType>
        <Month>unsignedByte</Month>
        <MonthlyByDay>boolean</MonthlyByDay>
        <MonthlyInterval>unsignedByte</MonthlyInterval>
        <StartDate>dateTime</StartDate>
        <WeeklyInterval>unsignedByte</WeeklyInterval>
        <WeekNumber>unsignedByte</WeekNumber>
      </template>
    </AddInvoiceTemplate>
  </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>
    <AddInvoiceTemplateResponse xmlns="http://payments.onsharp.com/">
      <AddInvoiceTemplateResult>
        <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>
      </AddInvoiceTemplateResult>
    </AddInvoiceTemplateResponse>
  </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>
    <AddInvoiceTemplate xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
      <template>
        <TemplateName>string</TemplateName>
        <Description>string</Description>
        <Amount>decimal</Amount>
        <DueDateInterval>short</DueDateInterval>
        <CustomerId>string</CustomerId>
        <NotifyCustomer>boolean</NotifyCustomer>
        <NotifyMerchant>boolean</NotifyMerchant>
        <IsDeleted>boolean</IsDeleted>
        <DayOfMonth>unsignedByte</DayOfMonth>
        <DayOfWeek>unsignedByte</DayOfWeek>
        <EndCondition>unsignedByte</EndCondition>
        <EndDate>dateTime</EndDate>
        <EndTimes>int</EndTimes>
        <IntervalDays>int</IntervalDays>
        <IntervalType>unsignedByte</IntervalType>
        <Month>unsignedByte</Month>
        <MonthlyByDay>boolean</MonthlyByDay>
        <MonthlyInterval>unsignedByte</MonthlyInterval>
        <StartDate>dateTime</StartDate>
        <WeeklyInterval>unsignedByte</WeeklyInterval>
        <WeekNumber>unsignedByte</WeekNumber>
      </template>
    </AddInvoiceTemplate>
  </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>
    <AddInvoiceTemplateResponse xmlns="http://payments.onsharp.com/">
      <AddInvoiceTemplateResult>
        <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>
      </AddInvoiceTemplateResult>
    </AddInvoiceTemplateResponse>
  </soap12:Body>
</soap12:Envelope>