SmartPayService Web Service

SmartPayService

Click here for a complete list of operations.

GetSettings

Gets the merchant settings.

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

<?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>
    <GetSettings xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
    </GetSettings>
  </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>
    <GetSettingsResponse xmlns="http://payments.onsharp.com/">
      <GetSettingsResult>
        <Settings>
          <SingleInvoiceMode>boolean</SingleInvoiceMode>
          <AllowAccountCredit>boolean</AllowAccountCredit>
          <AutopayDisabled>boolean</AutopayDisabled>
          <PaymentPlansDisabled>boolean</PaymentPlansDisabled>
          <Payment>
            <Terms>string</Terms>
            <InvoiceNumberStart>int</InvoiceNumberStart>
            <MaximumPaymentAmount>decimal</MaximumPaymentAmount>
            <PostDueDateDaysAllowed>int</PostDueDateDaysAllowed>
            <AllowPartial>boolean</AllowPartial>
            <AllowOverPayment>boolean</AllowOverPayment>
            <AllowNegativeInvoices>boolean</AllowNegativeInvoices>
            <AllowCreditCards>boolean</AllowCreditCards>
            <AllowCreditCardCredits>boolean</AllowCreditCardCredits>
            <CreditCardSwipers>boolean</CreditCardSwipers>
            <AcceptedCreditCards>string</AcceptedCreditCards>
            <AllowAch>boolean</AllowAch>
            <AllowAchCredits>boolean</AllowAchCredits>
            <AutoSendNsf>boolean</AutoSendNsf>
          </Payment>
          <Surcharges>
            <CreditCardText>string</CreditCardText>
            <CreditCardType>string</CreditCardType>
            <CreditCardAmount>decimal</CreditCardAmount>
            <AchText>string</AchText>
            <AchType>string</AchType>
            <AchAmount>decimal</AchAmount>
          </Surcharges>
          <Templates>
            <Invoice>string</Invoice>
            <PaymentReceipt>string</PaymentReceipt>
            <InvoiceLineItems>string</InvoiceLineItems>
          </Templates>
          <Reminders>
            <Autopay>boolean</Autopay>
            <AutopayDays>int</AutopayDays>
            <CreditCardExpiration>boolean</CreditCardExpiration>
            <CreditCardExpirationDays>int</CreditCardExpirationDays>
            <Payment>boolean</Payment>
            <PaymentDays>int</PaymentDays>
          </Reminders>
          <Customization>
            <AutopayMessage>string</AutopayMessage>
            <AutopayTermsConditions>string</AutopayTermsConditions>
            <LogOnUserNameText>string</LogOnUserNameText>
            <LogOnPasswordText>string</LogOnPasswordText>
            <LogOnMessage>string</LogOnMessage>
            <PaymentMessage>string</PaymentMessage>
            <InvoiceOverpaymentMessage>string</InvoiceOverpaymentMessage>
            <WelcomeMessage>string</WelcomeMessage>
            <InvoiceReplacementText>string</InvoiceReplacementText>
            <InvoicesReplacementText>string</InvoicesReplacementText>
            <CustomerReplacementText>string</CustomerReplacementText>
            <CustomersReplacementText>string</CustomersReplacementText>
            <StatementReplacementText>string</StatementReplacementText>
            <StatementsReplacementText>string</StatementsReplacementText>
            <LogoImage>string</LogoImage>
            <SystemName>string</SystemName>
            <GeneralPaymentText>string</GeneralPaymentText>
            <ManualGeneralPaymentText>string</ManualGeneralPaymentText>
            <ProfileMessage>string</ProfileMessage>
          </Customization>
          <Theme>
            <FontFamily>string</FontFamily>
            <Primary>string</Primary>
            <PrimaryBackground>string</PrimaryBackground>
            <MainBorder>string</MainBorder>
            <ContentBackground>string</ContentBackground>
            <PrimaryText>string</PrimaryText>
            <MenuBorder>string</MenuBorder>
            <MenuBackground>string</MenuBackground>
            <MenuText>string</MenuText>
            <MenuMouseOver>string</MenuMouseOver>
            <InputBorder>string</InputBorder>
            <HeaderBackgroundImage>string</HeaderBackgroundImage>
            <Header>string</Header>
            <HeaderText>string</HeaderText>
            <LogoutLink>string</LogoutLink>
            <SecondaryHeader>string</SecondaryHeader>
            <Link>string</Link>
            <LinkHover>string</LinkHover>
            <AltTableRow>string</AltTableRow>
            <TableMouseOver>string</TableMouseOver>
          </Theme>
          <Enrollment>
            <Enabled>boolean</Enabled>
            <LinkText>string</LinkText>
            <FormHeaderText>string</FormHeaderText>
            <FormMessage>string</FormMessage>
            <VerifyHeaderText>string</VerifyHeaderText>
            <VerifyMessage>string</VerifyMessage>
            <ErrorMessage>string</ErrorMessage>
            <EnrollSuccessMessage>string</EnrollSuccessMessage>
          </Enrollment>
          <CustomFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
          <LockedFields>
            <LockedField xsi:nil="true" />
            <LockedField xsi:nil="true" />
          </LockedFields>
          <EmailTemplates>
            <EnrollVerify xsi:nil="true" />
            <EnrollComplete xsi:nil="true" />
            <Welcome xsi:nil="true" />
            <SendLogOn xsi:nil="true" />
            <SendLogOnUserName xsi:nil="true" />
            <PaymentConfirmation xsi:nil="true" />
            <PaymentReminder xsi:nil="true" />
            <AutopayDeclined xsi:nil="true" />
            <AutopayReminder xsi:nil="true" />
            <CreditCardExpirationReminder xsi:nil="true" />
            <Invoice xsi:nil="true" />
            <Statement xsi:nil="true" />
            <Nsf xsi:nil="true" />
            <Refund xsi:nil="true" />
          </EmailTemplates>
        </Settings>
      </GetSettingsResult>
    </GetSettingsResponse>
  </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>
    <GetSettings xmlns="http://payments.onsharp.com/">
      <sessionId>string</sessionId>
    </GetSettings>
  </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>
    <GetSettingsResponse xmlns="http://payments.onsharp.com/">
      <GetSettingsResult>
        <Settings>
          <SingleInvoiceMode>boolean</SingleInvoiceMode>
          <AllowAccountCredit>boolean</AllowAccountCredit>
          <AutopayDisabled>boolean</AutopayDisabled>
          <PaymentPlansDisabled>boolean</PaymentPlansDisabled>
          <Payment>
            <Terms>string</Terms>
            <InvoiceNumberStart>int</InvoiceNumberStart>
            <MaximumPaymentAmount>decimal</MaximumPaymentAmount>
            <PostDueDateDaysAllowed>int</PostDueDateDaysAllowed>
            <AllowPartial>boolean</AllowPartial>
            <AllowOverPayment>boolean</AllowOverPayment>
            <AllowNegativeInvoices>boolean</AllowNegativeInvoices>
            <AllowCreditCards>boolean</AllowCreditCards>
            <AllowCreditCardCredits>boolean</AllowCreditCardCredits>
            <CreditCardSwipers>boolean</CreditCardSwipers>
            <AcceptedCreditCards>string</AcceptedCreditCards>
            <AllowAch>boolean</AllowAch>
            <AllowAchCredits>boolean</AllowAchCredits>
            <AutoSendNsf>boolean</AutoSendNsf>
          </Payment>
          <Surcharges>
            <CreditCardText>string</CreditCardText>
            <CreditCardType>string</CreditCardType>
            <CreditCardAmount>decimal</CreditCardAmount>
            <AchText>string</AchText>
            <AchType>string</AchType>
            <AchAmount>decimal</AchAmount>
          </Surcharges>
          <Templates>
            <Invoice>string</Invoice>
            <PaymentReceipt>string</PaymentReceipt>
            <InvoiceLineItems>string</InvoiceLineItems>
          </Templates>
          <Reminders>
            <Autopay>boolean</Autopay>
            <AutopayDays>int</AutopayDays>
            <CreditCardExpiration>boolean</CreditCardExpiration>
            <CreditCardExpirationDays>int</CreditCardExpirationDays>
            <Payment>boolean</Payment>
            <PaymentDays>int</PaymentDays>
          </Reminders>
          <Customization>
            <AutopayMessage>string</AutopayMessage>
            <AutopayTermsConditions>string</AutopayTermsConditions>
            <LogOnUserNameText>string</LogOnUserNameText>
            <LogOnPasswordText>string</LogOnPasswordText>
            <LogOnMessage>string</LogOnMessage>
            <PaymentMessage>string</PaymentMessage>
            <InvoiceOverpaymentMessage>string</InvoiceOverpaymentMessage>
            <WelcomeMessage>string</WelcomeMessage>
            <InvoiceReplacementText>string</InvoiceReplacementText>
            <InvoicesReplacementText>string</InvoicesReplacementText>
            <CustomerReplacementText>string</CustomerReplacementText>
            <CustomersReplacementText>string</CustomersReplacementText>
            <StatementReplacementText>string</StatementReplacementText>
            <StatementsReplacementText>string</StatementsReplacementText>
            <LogoImage>string</LogoImage>
            <SystemName>string</SystemName>
            <GeneralPaymentText>string</GeneralPaymentText>
            <ManualGeneralPaymentText>string</ManualGeneralPaymentText>
            <ProfileMessage>string</ProfileMessage>
          </Customization>
          <Theme>
            <FontFamily>string</FontFamily>
            <Primary>string</Primary>
            <PrimaryBackground>string</PrimaryBackground>
            <MainBorder>string</MainBorder>
            <ContentBackground>string</ContentBackground>
            <PrimaryText>string</PrimaryText>
            <MenuBorder>string</MenuBorder>
            <MenuBackground>string</MenuBackground>
            <MenuText>string</MenuText>
            <MenuMouseOver>string</MenuMouseOver>
            <InputBorder>string</InputBorder>
            <HeaderBackgroundImage>string</HeaderBackgroundImage>
            <Header>string</Header>
            <HeaderText>string</HeaderText>
            <LogoutLink>string</LogoutLink>
            <SecondaryHeader>string</SecondaryHeader>
            <Link>string</Link>
            <LinkHover>string</LinkHover>
            <AltTableRow>string</AltTableRow>
            <TableMouseOver>string</TableMouseOver>
          </Theme>
          <Enrollment>
            <Enabled>boolean</Enabled>
            <LinkText>string</LinkText>
            <FormHeaderText>string</FormHeaderText>
            <FormMessage>string</FormMessage>
            <VerifyHeaderText>string</VerifyHeaderText>
            <VerifyMessage>string</VerifyMessage>
            <ErrorMessage>string</ErrorMessage>
            <EnrollSuccessMessage>string</EnrollSuccessMessage>
          </Enrollment>
          <CustomFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
          <LockedFields>
            <LockedField xsi:nil="true" />
            <LockedField xsi:nil="true" />
          </LockedFields>
          <EmailTemplates>
            <EnrollVerify xsi:nil="true" />
            <EnrollComplete xsi:nil="true" />
            <Welcome xsi:nil="true" />
            <SendLogOn xsi:nil="true" />
            <SendLogOnUserName xsi:nil="true" />
            <PaymentConfirmation xsi:nil="true" />
            <PaymentReminder xsi:nil="true" />
            <AutopayDeclined xsi:nil="true" />
            <AutopayReminder xsi:nil="true" />
            <CreditCardExpirationReminder xsi:nil="true" />
            <Invoice xsi:nil="true" />
            <Statement xsi:nil="true" />
            <Nsf xsi:nil="true" />
            <Refund xsi:nil="true" />
          </EmailTemplates>
        </Settings>
      </GetSettingsResult>
    </GetSettingsResponse>
  </soap12:Body>
</soap12:Envelope>