Billhighway Cloud API

<back to all web services

BillMeLaterSubscription

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO
Imports BH.CloudAPI.Common.DTO
Imports BH.CloudAPI.Common4.DTO.SalesForce
Imports BH.CloudAPI.Common4.DTO.Subscriptions

Namespace Global

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class ApiClientHeader
            Public Overridable Property ClientId As Integer
            Public Overridable Property Referrer As String
            Public Overridable Property IpAddress As String
            Public Overridable Property LoggedInUserId As Integer
            Public Overridable Property GroupId As Integer
            Public Overridable Property Task As String
            Public Overridable Property Machine As String
            Public Overridable Property Location As String
            Public Overridable Property CreatedBy As Integer
            Public Overridable Property CampaignId As Integer
            Public Overridable Property ReCaptchaScore As Nullable(Of Decimal)
        End Class

        Public Partial Class BillMeCloudServiceResponse
            Public Overridable Property IsDuplicate As Boolean
            Public Overridable Property IsSuccessful As Boolean
            Public Overridable Property ErrorCode As String
            Public Overridable Property Message As String
            Public Overridable Property IsError As Boolean
        End Class

        Public Partial Class BillMePaymentResult
            Inherits BillMeCloudServiceResponse
            Public Overridable Property TransactionRecordID As Long
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class BillMeLaterSubscription
            Public Sub New()
                CampaignInfo = New List(Of CampaignInformation)
            End Sub

            Public Overridable Property Header As ApiClientHeader
            Public Overridable Property SubscriptionInfo As SubscriptionParameters
            Public Overridable Property CampaignInfo As List(Of CampaignInformation)
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.SalesForce

        Public Partial Class SubscriberFormField
            Public Overridable Property Name As String
            Public Overridable Property Value 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 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 BillMeLaterSubscription 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 /xml/reply/BillMeLaterSubscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BillMeLaterSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <CampaignInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:CampaignInformation>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:CampaignId>0</d2p1:CampaignId>
      <d2p1:CampaignName>String</d2p1:CampaignName>
      <d2p1:ChapPayID>String</d2p1:ChapPayID>
    </d2p1:CampaignInformation>
  </CampaignInfo>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <d2p1:CampaignId>0</d2p1:CampaignId>
    <d2p1:ClientId>0</d2p1:ClientId>
    <d2p1:CreatedBy>0</d2p1:CreatedBy>
    <d2p1:GroupId>0</d2p1:GroupId>
    <d2p1:IpAddress>String</d2p1:IpAddress>
    <d2p1:Location>String</d2p1:Location>
    <d2p1:LoggedInUserId>0</d2p1:LoggedInUserId>
    <d2p1:Machine>String</d2p1:Machine>
    <d2p1:ReCaptchaScore>0</d2p1:ReCaptchaScore>
    <d2p1:Referrer>String</d2p1:Referrer>
    <d2p1:Task>String</d2p1:Task>
  </Header>
  <SubscriptionInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
    <d2p1:AptifyUpdateType>0</d2p1:AptifyUpdateType>
    <d2p1:AutoRenew>false</d2p1:AutoRenew>
    <d2p1:ChapId>0</d2p1:ChapId>
    <d2p1:ChapMemPayID>0</d2p1:ChapMemPayID>
    <d2p1:ClientSubscriberId>String</d2p1:ClientSubscriberId>
    <d2p1:CompanyID>0</d2p1:CompanyID>
    <d2p1:CreatedBy>0</d2p1:CreatedBy>
    <d2p1:Fields>
      <d2p1:SubscriberFormField>
        <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
        <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
      </d2p1:SubscriberFormField>
    </d2p1:Fields>
    <d2p1:FormTemplateID>0</d2p1:FormTemplateID>
    <d2p1:FrequencyID>0</d2p1:FrequencyID>
    <d2p1:MemberSubscriptionInvID>0</d2p1:MemberSubscriptionInvID>
    <d2p1:RenewedMemberSubscriptionInvID>0</d2p1:RenewedMemberSubscriptionInvID>
    <d2p1:SignupTypeID>0</d2p1:SignupTypeID>
    <d2p1:SubscriptionInvoiceID>0</d2p1:SubscriptionInvoiceID>
    <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
    <d2p1:UserID>0</d2p1:UserID>
  </SubscriptionInfo>
</BillMeLaterSubscription>

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

<BillMePaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ErrorCode>String</ErrorCode>
  <IsDuplicate>false</IsDuplicate>
  <IsError>false</IsError>
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
  <TransactionRecordID>0</TransactionRecordID>
</BillMePaymentResult>