Billhighway Cloud API

BillMeLaterSubscription

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


open class BillMeLaterSubscription
{
    var Header:ApiClientHeader? = null
    var SubscriptionInfo:SubscriptionParameters? = null
    var CampaignInfo:ArrayList<CampaignInformation> = ArrayList<CampaignInformation>()
}

open class ApiClientHeader
{
    var ClientId:Int? = null
    var Referrer:String? = null
    var IpAddress:String? = null
    var LoggedInUserId:Int? = null
    var GroupId:Int? = null
    var Task:String? = null
    var Machine:String? = null
    var Location:String? = null
    var CreatedBy:Int? = null
    var CampaignId:Int? = null
    var ReCaptchaScore:BigDecimal? = 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 SubscriberFormField
{
    var Name:String? = null
    var Value:String? = null
}

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

open class BillMePaymentResult : BillMeCloudServiceResponse()
{
    var TransactionRecordID:Long? = null
}

open class BillMeCloudServiceResponse
{
    var IsDuplicate:Boolean? = null
    var IsSuccessful:Boolean? = null
    var ErrorCode:String? = null
    var Message:String? = null
    var IsError:Boolean? = null
}

Kotlin 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>