Billhighway Cloud API

Smp

The following routes are available for this service:
POST	/SMP

import java.math.*
import java.util.*
import net.servicestack.client.*


open class Smp
{
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserId:Int? = null
    var AdminId:Int? = null
    var MemberInfo:Member? = null
    var CcPaymentInfo:CreditCardPayment? = null
    var AchPaymentInfo:AchPayment? = null
    var Subscription:Subscription? = null
    var BillMeLaterInfo:BillMeLaterInformation? = null
}

open class Member
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserId:String? = null
    var AlternateUserId:String? = null
    var BhUserId:Int? = null
    var FirstName:String? = null
    var LastName:String? = null
    var MiddleName:String? = null
    var PreferredEmailAddress:String? = null
    var OtherEmailAddress:String? = null
    var PreferredPhoneNumber:String? = null
    var PreferredAddress1:String? = null
    var PreferredAddress2:String? = null
    var PreferredCity:String? = null
    var PreferredState:String? = null
    var PreferredZip:String? = null
    var PreferredCountry:String? = null
    var AccessLevel:String? = null
    var MemberStatus:String? = null
    var MemberTypeClient:String? = null
    var BillingType:String? = null
    var FiscalYear:Int? = null
    var WorkLocation:String? = null
    var DOB:Date? = null
    var Paperless:String? = null
    var DisplayName:String? = null
    var DisableLogin:String? = null
    var RecurringInvoiceSettings:RecurringInvoiceSettings? = null
    var FormFields:ArrayList<SubscriberFormField> = ArrayList<SubscriberFormField>()
    var Attributes:ArrayList<AttributeItem> = ArrayList<AttributeItem>()
    var GroupList:ArrayList<Chapter> = ArrayList<Chapter>()
}

open class RecurringInvoiceSettings
{
    var DonationAmount:String? = null
}

open class SubscriberFormField
{
    var Name:String? = null
    var Value:String? = null
}

open class AttributeItem
{
    var Name:String? = null
    var Value:String? = null
}

open class Chapter
{
    var GroupId:String? = null
}

open class CreditCardPayment : CreditCardPayment()
{
    var SubscriptionInfo:SubscriptionParameters? = null
}

open class SubscriptionParameters
{
    var FormTemplateID:Int? = null
    var SubscriptionInvoiceID:Int? = null
    var ClientSubscriberId:String? = null
    var SignupTypeID:Int? = null
    var FrequencyID:Int? = null
    var AutoRenew:Boolean? = null
    var CompanyID:Long? = null
    var UserID:Int? = null
    var ChapMemPayID:Long? = null
    var MemberSubscriptionInvID:Long? = null
    var Fields:ArrayList<SubscriberFormField> = ArrayList<SubscriberFormField>()
    var CreatedBy:Int? = null
    var UpdatedBy:Int? = null
    var AptifyUpdateType:Int? = null
    var RenewedMemberSubscriptionInvID:Long? = null
    var ChapId:Int? = null
}

open class AchPayment
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserId:String? = null
    var BhUserId:Int? = null
    var Amount:BigDecimal? = null
    var CurrencyType:String? = null
    var Country:String? = null
    var RoutingNumber:String? = null
    var AccountNumber:String? = null
    var AchReference:String? = null
    var AccountType:String? = null
    var IsSavingsAccount:Boolean? = null
    var PayerName:String? = null
    var CheckNumber:String? = null
    var PreferredEmailAddress:String? = null
    var Memo:String? = null
    var InvoiceList:ArrayList<SalesForceMemberPaymentInvoiceDetail> = ArrayList<SalesForceMemberPaymentInvoiceDetail>()
    var AutoPay:Boolean? = null
    var StoreAchInfo:Boolean? = null
    var EncryptionTypeId:Int? = null
}

open class SalesForceMemberPaymentInvoiceDetail
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var Invoice:Int? = null
    var AmountPaid:String? = null
}

open class Subscription
{
    var UniqueId:String? = null
    var FormTemplateID:Int? = null
    var SubscriptionInvoiceID:Int? = null
    var ClientSubscriberId:String? = null
    var SignupTypeID:Int? = null
    var FrequencyID:Int? = null
    var AutoRenew:Boolean? = null
    var UserID:Int? = null
    var ChapMemPayID:Long? = null
    var Fields:ArrayList<SubscriberFormField> = ArrayList<SubscriberFormField>()
    var CreatedBy:Int? = null
    var UpdatedBy:Int? = null
    var RenewedMemberSubscriptionInvID:Long? = null
    var SubscriptionTypeId:String? = null
}

open class BillMeLaterInformation
{
    var IsBillMeLaterPayment:Boolean? = null
    var IsBillMeLaterSubscription:Boolean? = null
    var MemberSubscriptionInvId:Int? = null
    var Campaigns:ArrayList<CampaignInformation> = ArrayList<CampaignInformation>()
}

open class CampaignInformation
{
    var CampaignId:Int? = null
    var CampaignName:String? = null
    var Amount:BigDecimal? = null
    var ChapPayID:String? = null
}

open class SmpReply : IHaveErrorField
{
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var BillhighwayUserId:Int? = null
    var ConfirmationNumber:String? = null
    var PaymentConfirmationNumber:Long? = null
    var SubscriptionConfirmationNumber:Long? = null
    var ErrorCode:Int? = null
    var ErrorMessage:String? = null
    var IsError:Boolean? = null
}

Kotlin Smp DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /SMP HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Smp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchPaymentInfo>
    <AccountNumber>String</AccountNumber>
    <AccountType>String</AccountType>
    <AchReference>String</AchReference>
    <Amount>0</Amount>
    <AutoPay>false</AutoPay>
    <BhUserId>0</BhUserId>
    <CheckNumber>String</CheckNumber>
    <ClassName>String</ClassName>
    <ClientId>0</ClientId>
    <Country>String</Country>
    <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
    <CurrencyType>String</CurrencyType>
    <EncryptionTypeId>0</EncryptionTypeId>
    <GroupId>String</GroupId>
    <InvoiceList>
      <SalesForceMemberPaymentInvoiceDetail>
        <AmountPaid>String</AmountPaid>
        <ClassName>String</ClassName>
        <ClientId>0</ClientId>
        <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
        <Invoice>0</Invoice>
        <UniqueId>String</UniqueId>
      </SalesForceMemberPaymentInvoiceDetail>
    </InvoiceList>
    <Memo>String</Memo>
    <PayerName>String</PayerName>
    <PreferredEmailAddress>String</PreferredEmailAddress>
    <RoutingNumber>String</RoutingNumber>
    <StoreAchInfo>false</StoreAchInfo>
    <UniqueId>String</UniqueId>
    <UserId>String</UserId>
  </AchPaymentInfo>
  <AdminId>0</AdminId>
  <BillMeLaterInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Campaigns>
      <d2p1:CampaignInformation>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:CampaignId>0</d2p1:CampaignId>
        <d2p1:CampaignName>String</d2p1:CampaignName>
        <d2p1:ChapPayID>String</d2p1:ChapPayID>
      </d2p1:CampaignInformation>
    </d2p1:Campaigns>
    <d2p1:IsBillMeLaterPayment>false</d2p1:IsBillMeLaterPayment>
    <d2p1:IsBillMeLaterSubscription>false</d2p1:IsBillMeLaterSubscription>
    <d2p1:MemberSubscriptionInvId>0</d2p1:MemberSubscriptionInvId>
  </BillMeLaterInfo>
  <CcPaymentInfo>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <Amount>String</Amount>
    <AutoPay>false</AutoPay>
    <BhUserId>0</BhUserId>
    <BillingCity>String</BillingCity>
    <BillingState>String</BillingState>
    <CardReferenceOrCardNumber>String</CardReferenceOrCardNumber>
    <CardType>String</CardType>
    <ClassName>String</ClassName>
    <ClientId>0</ClientId>
    <Country>String</Country>
    <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
    <CurrencyType>String</CurrencyType>
    <Cvv>String</Cvv>
    <ExpMonth>0</ExpMonth>
    <ExpYear>0</ExpYear>
    <GroupId>String</GroupId>
    <InvoiceList>
      <SalesForceMemberPaymentInvoiceDetail>
        <AmountPaid>String</AmountPaid>
        <ClassName>String</ClassName>
        <ClientId>0</ClientId>
        <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
        <Invoice>0</Invoice>
        <UniqueId>String</UniqueId>
      </SalesForceMemberPaymentInvoiceDetail>
    </InvoiceList>
    <Location>String</Location>
    <Memo>String</Memo>
    <NameOnCard>String</NameOnCard>
    <OpportunityId>String</OpportunityId>
    <PostalCode>String</PostalCode>
    <PreferredEmailAddress>String</PreferredEmailAddress>
    <StoreCardInfo>false</StoreCardInfo>
    <UniqueId>String</UniqueId>
    <UserId>String</UserId>
  </CcPaymentInfo>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <GroupId>String</GroupId>
  <MemberInfo>
    <AccessLevel>String</AccessLevel>
    <AlternateUserId>String</AlternateUserId>
    <Attributes xmlns:d3p1="https://www.billhighway.com/api">
      <d3p1:AttributeItem>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:AttributeItem>
    </Attributes>
    <BhUserId>0</BhUserId>
    <BillingType>String</BillingType>
    <ClassName>String</ClassName>
    <ClientId>0</ClientId>
    <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
    <DOB>0001-01-01T00:00:00</DOB>
    <DisableLogin>String</DisableLogin>
    <DisplayName>String</DisplayName>
    <FirstName>String</FirstName>
    <FiscalYear>0</FiscalYear>
    <FormFields>
      <SubscriberFormField>
        <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
        <_x003C_Value_x003E_k__BackingField>String</_x003C_Value_x003E_k__BackingField>
      </SubscriberFormField>
    </FormFields>
    <GroupId>String</GroupId>
    <GroupList xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
      <d3p1:Chapter>
        <d3p1:GroupId>String</d3p1:GroupId>
      </d3p1:Chapter>
    </GroupList>
    <LastName>String</LastName>
    <MemberStatus>String</MemberStatus>
    <MemberTypeClient>String</MemberTypeClient>
    <MiddleName>String</MiddleName>
    <OtherEmailAddress>String</OtherEmailAddress>
    <Paperless>String</Paperless>
    <PreferredAddress1>String</PreferredAddress1>
    <PreferredAddress2>String</PreferredAddress2>
    <PreferredCity>String</PreferredCity>
    <PreferredCountry>String</PreferredCountry>
    <PreferredEmailAddress>String</PreferredEmailAddress>
    <PreferredPhoneNumber>String</PreferredPhoneNumber>
    <PreferredState>String</PreferredState>
    <PreferredZip>String</PreferredZip>
    <RecurringInvoiceSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.Member">
      <d3p1:DonationAmount>String</d3p1:DonationAmount>
    </RecurringInvoiceSettings>
    <UniqueId>String</UniqueId>
    <UserId>String</UserId>
    <WorkLocation>String</WorkLocation>
  </MemberInfo>
  <Subscription>
    <_x003C_AutoRenew_x003E_k__BackingField>false</_x003C_AutoRenew_x003E_k__BackingField>
    <_x003C_ChapMemPayID_x003E_k__BackingField>0</_x003C_ChapMemPayID_x003E_k__BackingField>
    <_x003C_ClientSubscriberId_x003E_k__BackingField>String</_x003C_ClientSubscriberId_x003E_k__BackingField>
    <_x003C_CreatedBy_x003E_k__BackingField>0</_x003C_CreatedBy_x003E_k__BackingField>
    <_x003C_Fields_x003E_k__BackingField>
      <SubscriberFormField>
        <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
        <_x003C_Value_x003E_k__BackingField>String</_x003C_Value_x003E_k__BackingField>
      </SubscriberFormField>
    </_x003C_Fields_x003E_k__BackingField>
    <_x003C_FormTemplateID_x003E_k__BackingField>0</_x003C_FormTemplateID_x003E_k__BackingField>
    <_x003C_FrequencyID_x003E_k__BackingField>0</_x003C_FrequencyID_x003E_k__BackingField>
    <_x003C_RenewedMemberSubscriptionInvID_x003E_k__BackingField>0</_x003C_RenewedMemberSubscriptionInvID_x003E_k__BackingField>
    <_x003C_SignupTypeID_x003E_k__BackingField>0</_x003C_SignupTypeID_x003E_k__BackingField>
    <_x003C_SubscriptionInvoiceID_x003E_k__BackingField>0</_x003C_SubscriptionInvoiceID_x003E_k__BackingField>
    <_x003C_SubscriptionTypeId_x003E_k__BackingField>String</_x003C_SubscriptionTypeId_x003E_k__BackingField>
    <_x003C_UniqueId_x003E_k__BackingField>String</_x003C_UniqueId_x003E_k__BackingField>
    <_x003C_UpdatedBy_x003E_k__BackingField>0</_x003C_UpdatedBy_x003E_k__BackingField>
    <_x003C_UserID_x003E_k__BackingField>0</_x003C_UserID_x003E_k__BackingField>
  </Subscription>
  <UniqueId>String</UniqueId>
  <UserId>0</UserId>
</Smp>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SmpReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <BillhighwayUserId>0</BillhighwayUserId>
  <ClientId>0</ClientId>
  <ConfirmationNumber>String</ConfirmationNumber>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <PaymentConfirmationNumber>0</PaymentConfirmationNumber>
  <SubscriptionConfirmationNumber>0</SubscriptionConfirmationNumber>
  <UniqueId>String</UniqueId>
</SmpReply>