Billhighway Cloud API

<back to all web services

Smp

The following routes are available for this service:
POST/SMP
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.SalesForce
Imports BH.CloudAPI.Common.DTO.Member
Imports BH.CloudAPI.Common4.DTO
Imports BH.CloudAPI.Common.DTO
Imports BH.CloudAPI.Common4.DTO.Subscriptions

Namespace Global

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class Chapter
            Public Overridable Property GroupId As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common.DTO.Member

        Public Partial Class RecurringInvoiceSettings
            Public Overridable Property DonationAmount As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class AttributeItem
            Public Overridable Property Name As String
            Public Overridable Property Value As String
        End Class

        Public Partial Class CreditCardPayment
            Inherits CreditCardPayment
            Public Overridable Property SubscriptionInfo As SubscriptionParameters
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.SalesForce

        Public Partial Class AchPayment
            Public Sub New()
                InvoiceList = New List(Of SalesForceMemberPaymentInvoiceDetail)
            End Sub

            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property UserId As String
            Public Overridable Property BhUserId As Integer
            Public Overridable Property Amount As Decimal
            Public Overridable Property CurrencyType As String
            Public Overridable Property Country As String
            Public Overridable Property RoutingNumber As String
            Public Overridable Property AccountNumber As String
            Public Overridable Property AchReference As String
            Public Overridable Property AccountType As String
            Public Overridable Property IsSavingsAccount As Boolean
            Public Overridable Property PayerName As String
            Public Overridable Property CheckNumber As String
            Public Overridable Property PreferredEmailAddress As String
            Public Overridable Property Memo As String
            Public Overridable Property InvoiceList As List(Of SalesForceMemberPaymentInvoiceDetail)
            Public Overridable Property AutoPay As Boolean
            Public Overridable Property StoreAchInfo As Boolean
            Public Overridable Property EncryptionTypeId As Integer
        End Class

        Public Partial Class Member
            Public Sub New()
                FormFields = New List(Of SubscriberFormField)
                Attributes = New List(Of AttributeItem)
                GroupList = New List(Of Chapter)
            End Sub

            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property UserId As String
            Public Overridable Property AlternateUserId As String
            Public Overridable Property BhUserId As Integer
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property MiddleName As String
            Public Overridable Property PreferredEmailAddress As String
            Public Overridable Property OtherEmailAddress As String
            Public Overridable Property PreferredPhoneNumber As String
            Public Overridable Property PreferredAddress1 As String
            Public Overridable Property PreferredAddress2 As String
            Public Overridable Property PreferredCity As String
            Public Overridable Property PreferredState As String
            Public Overridable Property PreferredZip As String
            Public Overridable Property PreferredCountry As String
            Public Overridable Property AccessLevel As String
            Public Overridable Property MemberStatus As String
            Public Overridable Property MemberTypeClient As String
            Public Overridable Property BillingType As String
            Public Overridable Property FiscalYear As Integer
            Public Overridable Property WorkLocation As String
            Public Overridable Property DOB As Date
            Public Overridable Property Paperless As String
            Public Overridable Property DisplayName As String
            Public Overridable Property DisableLogin As String
            Public Overridable Property RecurringInvoiceSettings As RecurringInvoiceSettings
            Public Overridable Property FormFields As List(Of SubscriberFormField)
            Public Overridable Property Attributes As List(Of AttributeItem)
            Public Overridable Property GroupList As List(Of Chapter)
        End Class

        Public Partial Class SalesForceMemberPaymentInvoiceDetail
            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property Invoice As Integer
            Public Overridable Property AmountPaid As String
        End Class

        Public Partial Class Smp
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property UserId As Integer
            Public Overridable Property AdminId As Integer
            Public Overridable Property MemberInfo As Member
            Public Overridable Property CcPaymentInfo As CreditCardPayment
            Public Overridable Property AchPaymentInfo As AchPayment
            Public Overridable Property Subscription As Subscription
            Public Overridable Property BillMeLaterInfo As BillMeLaterInformation
        End Class

        Public Partial Class SmpReply
            Implements IHaveErrorField
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property BillhighwayUserId As Integer
            Public Overridable Property ConfirmationNumber As String
            Public Overridable Property PaymentConfirmationNumber As Long
            Public Overridable Property SubscriptionConfirmationNumber As Long
            Public Overridable Property ErrorCode As Integer
            Public Overridable Property ErrorMessage As String
            Public Overridable Property IsError As Boolean
        End Class

        Public Partial Class SubscriberFormField
            Public Overridable Property Name As String
            Public Overridable Property Value As String
        End Class

        Public Partial Class Subscription
            Public Sub New()
                Fields = New List(Of SubscriberFormField)
            End Sub

            Public Overridable Property UniqueId As String
            Public Overridable Property FormTemplateID As Integer
            Public Overridable Property SubscriptionInvoiceID As Integer
            Public Overridable Property ClientSubscriberId As String
            Public Overridable Property SignupTypeID As Integer
            Public Overridable Property FrequencyID As Integer
            Public Overridable Property AutoRenew As Boolean
            Public Overridable Property UserID As Integer
            Public Overridable Property ChapMemPayID As Long
            Public Overridable Property Fields As List(Of SubscriberFormField)
            Public Overridable Property CreatedBy As Integer
            Public Overridable Property UpdatedBy As Integer
            Public Overridable Property RenewedMemberSubscriptionInvID As Long
            Public Overridable Property SubscriptionTypeId As String
        End Class

        Public Partial Class SubscriptionParameters
            Public Sub New()
                Fields = New List(Of SubscriberFormField)
            End Sub

            Public Overridable Property FormTemplateID As Integer
            Public Overridable Property SubscriptionInvoiceID As Integer
            Public Overridable Property ClientSubscriberId As String
            Public Overridable Property SignupTypeID As Integer
            Public Overridable Property FrequencyID As Integer
            Public Overridable Property AutoRenew As Boolean
            Public Overridable Property CompanyID As Long
            Public Overridable Property UserID As Integer
            Public Overridable Property ChapMemPayID As Long
            Public Overridable Property MemberSubscriptionInvID As Long
            Public Overridable Property Fields As List(Of SubscriberFormField)
            Public Overridable Property CreatedBy As Integer
            Public Overridable Property UpdatedBy As Integer
            Public Overridable Property AptifyUpdateType As Integer
            Public Overridable Property RenewedMemberSubscriptionInvID As Long
            Public Overridable Property ChapId As Integer
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.Subscriptions

        Public Partial Class BillMeLaterInformation
            Public Sub New()
                Campaigns = New List(Of CampaignInformation)
            End Sub

            Public Overridable Property IsBillMeLaterPayment As Boolean
            Public Overridable Property IsBillMeLaterSubscription As Boolean
            Public Overridable Property MemberSubscriptionInvId As Integer
            Public Overridable Property Campaigns As List(Of CampaignInformation)
        End Class

        Public Partial Class CampaignInformation
            Public Overridable Property CampaignId As Integer
            Public Overridable Property CampaignName As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property ChapPayID As String
        End Class
    End Namespace
End Namespace

VB.NET 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>