SmartPayService Web Service

SmartPayService

Click here for a complete list of operations.

CreatePayment

Creates a payment in SmartPay, optionally processing the specified credit card or ACH account, and optionally creates a new customer to associate the payment with.

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

<?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>
    <CreatePayment xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
      <merchantId>string</merchantId>
      <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>
      <manualPayment>boolean</manualPayment>
      <bankAccount>
        <BankAccountId>guid</BankAccountId>
        <CustomerId>string</CustomerId>
        <CustomerName>string</CustomerName>
        <AccountNumber>string</AccountNumber>
        <AccountTypeId>int</AccountTypeId>
        <AccountTypeName>string</AccountTypeName>
        <BankName>string</BankName>
        <Country>string</Country>
        <Name>string</Name>
        <Options>string</Options>
        <NameOnAccount>string</NameOnAccount>
        <RoutingNumber>string</RoutingNumber>
      </bankAccount>
      <creditCardAccount>
        <CreditCardId>guid</CreditCardId>
        <CustomerId>string</CustomerId>
        <CustomerName>string</CustomerName>
        <GatewayRecordId>string</GatewayRecordId>
        <Address>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </Address>
        <IssuerPhone>string</IssuerPhone>
        <CardTypeId>int</CardTypeId>
        <CardTypeName>string</CardTypeName>
        <Name>string</Name>
        <NameOnCard>string</NameOnCard>
        <Token>string</Token>
        <CardNumber>string</CardNumber>
        <Expiration>dateTime</Expiration>
        <Cvv2>string</Cvv2>
        <Options>string</Options>
      </creditCardAccount>
      <createCustomer>boolean</createCustomer>
      <customer>
        <CustomerId>string</CustomerId>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <BusinessName>string</BusinessName>
        <UserName>string</UserName>
        <Password>string</Password>
        <LastUpdated>dateTime</LastUpdated>
        <PrimaryAddress>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </PrimaryAddress>
        <BillingAddress>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </BillingAddress>
        <PhoneNumberDaytime>string</PhoneNumberDaytime>
        <PhoneNumberEvening>string</PhoneNumberEvening>
        <PhoneNumberCell>string</PhoneNumberCell>
        <PhoneNumberFax>string</PhoneNumberFax>
        <Email>string</Email>
        <Email2>string</Email2>
        <Email3>string</Email3>
        <IsDeleted>boolean</IsDeleted>
        <Data>xml</Data>
      </customer>
      <sendWelcomeEmail>boolean</sendWelcomeEmail>
    </CreatePayment>
  </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>
    <CreatePaymentResponse xmlns="http://payments.onsharp.com/">
      <CreatePaymentResult>
        <SurchargeAmount>decimal</SurchargeAmount>
      </CreatePaymentResult>
    </CreatePaymentResponse>
  </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>
    <CreatePayment xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
      <merchantId>string</merchantId>
      <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>
      <manualPayment>boolean</manualPayment>
      <bankAccount>
        <BankAccountId>guid</BankAccountId>
        <CustomerId>string</CustomerId>
        <CustomerName>string</CustomerName>
        <AccountNumber>string</AccountNumber>
        <AccountTypeId>int</AccountTypeId>
        <AccountTypeName>string</AccountTypeName>
        <BankName>string</BankName>
        <Country>string</Country>
        <Name>string</Name>
        <Options>string</Options>
        <NameOnAccount>string</NameOnAccount>
        <RoutingNumber>string</RoutingNumber>
      </bankAccount>
      <creditCardAccount>
        <CreditCardId>guid</CreditCardId>
        <CustomerId>string</CustomerId>
        <CustomerName>string</CustomerName>
        <GatewayRecordId>string</GatewayRecordId>
        <Address>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </Address>
        <IssuerPhone>string</IssuerPhone>
        <CardTypeId>int</CardTypeId>
        <CardTypeName>string</CardTypeName>
        <Name>string</Name>
        <NameOnCard>string</NameOnCard>
        <Token>string</Token>
        <CardNumber>string</CardNumber>
        <Expiration>dateTime</Expiration>
        <Cvv2>string</Cvv2>
        <Options>string</Options>
      </creditCardAccount>
      <createCustomer>boolean</createCustomer>
      <customer>
        <CustomerId>string</CustomerId>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <BusinessName>string</BusinessName>
        <UserName>string</UserName>
        <Password>string</Password>
        <LastUpdated>dateTime</LastUpdated>
        <PrimaryAddress>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </PrimaryAddress>
        <BillingAddress>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </BillingAddress>
        <PhoneNumberDaytime>string</PhoneNumberDaytime>
        <PhoneNumberEvening>string</PhoneNumberEvening>
        <PhoneNumberCell>string</PhoneNumberCell>
        <PhoneNumberFax>string</PhoneNumberFax>
        <Email>string</Email>
        <Email2>string</Email2>
        <Email3>string</Email3>
        <IsDeleted>boolean</IsDeleted>
        <Data>xml</Data>
      </customer>
      <sendWelcomeEmail>boolean</sendWelcomeEmail>
    </CreatePayment>
  </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>
    <CreatePaymentResponse xmlns="http://payments.onsharp.com/">
      <CreatePaymentResult>
        <SurchargeAmount>decimal</SurchargeAmount>
      </CreatePaymentResult>
    </CreatePaymentResponse>
  </soap12:Body>
</soap12:Envelope>