Billhighway Cloud API

<back to all web services

Smp

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

namespace BH.CloudAPI.Common.DTO
{
    public partial class Chapter
    {
        public virtual string GroupId { get; set; }
    }

}

namespace BH.CloudAPI.Common.DTO.Member
{
    public partial class RecurringInvoiceSettings
    {
        public virtual string DonationAmount { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class AttributeItem
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

    public partial class CreditCardPayment
        : CreditCardPayment
    {
        public virtual SubscriptionParameters SubscriptionInfo { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.SalesForce
{
    public partial class AchPayment
    {
        public AchPayment()
        {
            InvoiceList = new List<SalesForceMemberPaymentInvoiceDetail>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string CurrencyType { get; set; }
        public virtual string Country { get; set; }
        public virtual string RoutingNumber { get; set; }
        public virtual string AccountNumber { get; set; }
        public virtual string AchReference { get; set; }
        public virtual string AccountType { get; set; }
        public virtual bool IsSavingsAccount { get; set; }
        public virtual string PayerName { get; set; }
        public virtual string CheckNumber { get; set; }
        public virtual string PreferredEmailAddress { get; set; }
        public virtual string Memo { get; set; }
        public virtual List<SalesForceMemberPaymentInvoiceDetail> InvoiceList { get; set; }
        public virtual bool AutoPay { get; set; }
        public virtual bool StoreAchInfo { get; set; }
        public virtual int EncryptionTypeId { get; set; }
    }

    public partial class Member
    {
        public Member()
        {
            FormFields = new List<SubscriberFormField>{};
            Attributes = new List<AttributeItem>{};
            GroupList = new List<Chapter>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual string AlternateUserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string MiddleName { get; set; }
        public virtual string PreferredEmailAddress { get; set; }
        public virtual string OtherEmailAddress { get; set; }
        public virtual string PreferredPhoneNumber { get; set; }
        public virtual string PreferredAddress1 { get; set; }
        public virtual string PreferredAddress2 { get; set; }
        public virtual string PreferredCity { get; set; }
        public virtual string PreferredState { get; set; }
        public virtual string PreferredZip { get; set; }
        public virtual string PreferredCountry { get; set; }
        public virtual string AccessLevel { get; set; }
        public virtual string MemberStatus { get; set; }
        public virtual string MemberTypeClient { get; set; }
        public virtual string BillingType { get; set; }
        public virtual int FiscalYear { get; set; }
        public virtual string WorkLocation { get; set; }
        public virtual DateTime DOB { get; set; }
        public virtual string Paperless { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual string DisableLogin { get; set; }
        public virtual RecurringInvoiceSettings RecurringInvoiceSettings { get; set; }
        public virtual List<SubscriberFormField> FormFields { get; set; }
        public virtual List<AttributeItem> Attributes { get; set; }
        public virtual List<Chapter> GroupList { get; set; }
    }

    public partial class SalesForceMemberPaymentInvoiceDetail
    {
        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual int Invoice { get; set; }
        public virtual string AmountPaid { get; set; }
    }

    public partial class Smp
    {
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual int UserId { get; set; }
        public virtual int AdminId { get; set; }
        public virtual Member MemberInfo { get; set; }
        public virtual CreditCardPayment CcPaymentInfo { get; set; }
        public virtual AchPayment AchPaymentInfo { get; set; }
        public virtual Subscription Subscription { get; set; }
        public virtual BillMeLaterInformation BillMeLaterInfo { get; set; }
    }

    public partial class SmpReply
        : IHaveErrorField
    {
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual int BillhighwayUserId { get; set; }
        public virtual string ConfirmationNumber { get; set; }
        public virtual long PaymentConfirmationNumber { get; set; }
        public virtual long SubscriptionConfirmationNumber { get; set; }
        public virtual int ErrorCode { get; set; }
        public virtual string ErrorMessage { get; set; }
        public virtual bool IsError { get; set; }
    }

    public partial class SubscriberFormField
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

    public partial class Subscription
    {
        public Subscription()
        {
            Fields = new List<SubscriberFormField>{};
        }

        public virtual string UniqueId { get; set; }
        public virtual int FormTemplateID { get; set; }
        public virtual int SubscriptionInvoiceID { get; set; }
        public virtual string ClientSubscriberId { get; set; }
        public virtual int SignupTypeID { get; set; }
        public virtual int FrequencyID { get; set; }
        public virtual bool AutoRenew { get; set; }
        public virtual int UserID { get; set; }
        public virtual long ChapMemPayID { get; set; }
        public virtual List<SubscriberFormField> Fields { get; set; }
        public virtual int CreatedBy { get; set; }
        public virtual int UpdatedBy { get; set; }
        public virtual long RenewedMemberSubscriptionInvID { get; set; }
        public virtual string SubscriptionTypeId { get; set; }
    }

    public partial class SubscriptionParameters
    {
        public SubscriptionParameters()
        {
            Fields = new List<SubscriberFormField>{};
        }

        public virtual int FormTemplateID { get; set; }
        public virtual int SubscriptionInvoiceID { get; set; }
        public virtual string ClientSubscriberId { get; set; }
        public virtual int SignupTypeID { get; set; }
        public virtual int FrequencyID { get; set; }
        public virtual bool AutoRenew { get; set; }
        public virtual long CompanyID { get; set; }
        public virtual int UserID { get; set; }
        public virtual long ChapMemPayID { get; set; }
        public virtual long MemberSubscriptionInvID { get; set; }
        public virtual List<SubscriberFormField> Fields { get; set; }
        public virtual int CreatedBy { get; set; }
        public virtual int UpdatedBy { get; set; }
        public virtual int AptifyUpdateType { get; set; }
        public virtual long RenewedMemberSubscriptionInvID { get; set; }
        public virtual int ChapId { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions
{
    public partial class BillMeLaterInformation
    {
        public BillMeLaterInformation()
        {
            Campaigns = new List<CampaignInformation>{};
        }

        public virtual bool IsBillMeLaterPayment { get; set; }
        public virtual bool IsBillMeLaterSubscription { get; set; }
        public virtual int MemberSubscriptionInvId { get; set; }
        public virtual List<CampaignInformation> Campaigns { get; set; }
    }

    public partial class CampaignInformation
    {
        public virtual int CampaignId { get; set; }
        public virtual string CampaignName { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string ChapPayID { get; set; }
    }

}

C# Smp DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":0,"AdminId":0,"MemberInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","AlternateUserId":"String","BhUserId":0,"FirstName":"String","LastName":"String","MiddleName":"String","PreferredEmailAddress":"String","OtherEmailAddress":"String","PreferredPhoneNumber":"String","PreferredAddress1":"String","PreferredAddress2":"String","PreferredCity":"String","PreferredState":"String","PreferredZip":"String","PreferredCountry":"String","AccessLevel":"String","MemberStatus":"String","MemberTypeClient":"String","BillingType":"String","FiscalYear":0,"WorkLocation":"String","DOB":"0001-01-01T00:00:00.0000000","Paperless":"String","DisplayName":"String","DisableLogin":"String","RecurringInvoiceSettings":{"DonationAmount":"String"},"FormFields":[{"Name":"String","Value":"String"}],"Attributes":[{"Name":"String","Value":"String"}],"GroupList":[{"GroupId":"String"}]},"CcPaymentInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Amount":"String","AutoPay":false,"CurrencyType":"String","Country":"String","CardReferenceOrCardNumber":"String","StoreCardInfo":false,"Address1":"String","Address2":"String","BillingCity":"String","BillingState":"String","PreferredEmailAddress":"String","Memo":"String","OpportunityId":"String","ExpMonth":0,"ExpYear":0,"Cvv":"String","PostalCode":"String","Location":"String","NameOnCard":"String","CardType":"String","InvoiceList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}]},"AchPaymentInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Amount":0,"CurrencyType":"String","Country":"String","RoutingNumber":"String","AccountNumber":"String","AchReference":"String","AccountType":"String","IsSavingsAccount":false,"PayerName":"String","CheckNumber":"String","PreferredEmailAddress":"String","Memo":"String","InvoiceList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}],"AutoPay":false,"StoreAchInfo":false,"EncryptionTypeId":0},"Subscription":{"UniqueId":"String","FormTemplateID":0,"SubscriptionInvoiceID":0,"ClientSubscriberId":"String","SignupTypeID":0,"FrequencyID":0,"AutoRenew":false,"UserID":0,"ChapMemPayID":0,"Fields":[{"Name":"String","Value":"String"}],"CreatedBy":0,"UpdatedBy":0,"RenewedMemberSubscriptionInvID":0,"SubscriptionTypeId":"String"},"BillMeLaterInfo":{"IsBillMeLaterPayment":false,"IsBillMeLaterSubscription":false,"MemberSubscriptionInvId":0,"Campaigns":[{"CampaignId":0,"CampaignName":"String","Amount":0,"ChapPayID":"String"}]}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"BillhighwayUserId":0,"ConfirmationNumber":"String","PaymentConfirmationNumber":0,"SubscriptionConfirmationNumber":0,"ErrorCode":0,"ErrorMessage":"String","IsError":false}