Billhighway Cloud API

<back to all web services

Smp

The following routes are available for this service:
POST/SMP
Smp Parameters:
NameParameterData TypeRequiredDescription
UniqueIdbodystringNo
CreatedDateTimebodyDateTimeNo
ClientIdbodyintNo
GroupIdbodystringNo
UserIdbodyintNo
AdminIdbodyintNo
MemberInfobodyMemberNo
CcPaymentInfobodyCreditCardPaymentNo
AchPaymentInfobodyAchPaymentNo
SubscriptionbodySubscriptionNo
BillMeLaterInfobodyBillMeLaterInformationNo
Member Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
AlternateUserIdformstringNo
BhUserIdformintNo
FirstNameformstringNo
LastNameformstringNo
MiddleNameformstringNo
PreferredEmailAddressformstringNo
OtherEmailAddressformstringNo
PreferredPhoneNumberformstringNo
PreferredAddress1formstringNo
PreferredAddress2formstringNo
PreferredCityformstringNo
PreferredStateformstringNo
PreferredZipformstringNo
PreferredCountryformstringNo
AccessLevelformstringNo
MemberStatusformstringNo
MemberTypeClientformstringNo
BillingTypeformstringNo
FiscalYearformintNo
WorkLocationformstringNo
DOBformDateTimeNo
PaperlessformstringNo
DisplayNameformstringNo
DisableLoginformstringNo
RecurringInvoiceSettingsformRecurringInvoiceSettingsNo
FormFieldsformList<SubscriberFormField>No
AttributesformList<AttributeItem>No
GroupListformList<Chapter>No
RecurringInvoiceSettings Parameters:
NameParameterData TypeRequiredDescription
DonationAmountformstringNo
SubscriberFormField Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
AttributeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
Chapter Parameters:
NameParameterData TypeRequiredDescription
GroupIdformstringNo
CreditCardPayment Parameters:
NameParameterData TypeRequiredDescription
SubscriptionInfoformSubscriptionParametersNo
SubscriptionParameters Parameters:
NameParameterData TypeRequiredDescription
FormTemplateIDformintNo
SubscriptionInvoiceIDformintNo
ClientSubscriberIdformstringNo
SignupTypeIDformintNo
FrequencyIDformintNo
AutoRenewformboolNo
CompanyIDformlongNo
UserIDformintNo
ChapMemPayIDformlongNo
MemberSubscriptionInvIDformlongNo
FieldsformList<SubscriberFormField>No
CreatedByformintNo
UpdatedByformintNo
AptifyUpdateTypeformintNo
RenewedMemberSubscriptionInvIDformlongNo
ChapIdformintNo
AchPayment Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
BhUserIdformintNo
AmountformdecimalNo
CurrencyTypeformstringNo
CountryformstringNo
RoutingNumberformstringNo
AccountNumberformstringNo
AchReferenceformstringNo
AccountTypeformstringNo
IsSavingsAccountformboolNo
PayerNameformstringNo
CheckNumberformstringNo
PreferredEmailAddressformstringNo
MemoformstringNo
InvoiceListformList<SalesForceMemberPaymentInvoiceDetail>No
AutoPayformboolNo
StoreAchInfoformboolNo
EncryptionTypeIdformintNo
SalesForceMemberPaymentInvoiceDetail Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
InvoiceformintNo
AmountPaidformstringNo
Subscription Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
FormTemplateIDformintNo
SubscriptionInvoiceIDformintNo
ClientSubscriberIdformstringNo
SignupTypeIDformintNo
FrequencyIDformintNo
AutoRenewformboolNo
UserIDformintNo
ChapMemPayIDformlongNo
FieldsformList<SubscriberFormField>No
CreatedByformintNo
UpdatedByformintNo
RenewedMemberSubscriptionInvIDformlongNo
SubscriptionTypeIdformstringNo
BillMeLaterInformation Parameters:
NameParameterData TypeRequiredDescription
IsBillMeLaterPaymentformboolNo
IsBillMeLaterSubscriptionformboolNo
MemberSubscriptionInvIdformintNo
CampaignsformList<CampaignInformation>No
CampaignInformation Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformintNo
CampaignNameformstringNo
AmountformdecimalNo
ChapPayIDformstringNo
SmpReply Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
BillhighwayUserIdformintNo
ConfirmationNumberformstringNo
PaymentConfirmationNumberformlongNo
SubscriptionConfirmationNumberformlongNo
ErrorCodeformintNo
ErrorMessageformstringNo
IsErrorformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}