Billhighway Cloud API

<back to all web services

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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/BillMeLaterSubscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		ClientId: 0,
		Referrer: String,
		IpAddress: String,
		LoggedInUserId: 0,
		GroupId: 0,
		Task: String,
		Machine: String,
		Location: String,
		CreatedBy: 0,
		CampaignId: 0,
		ReCaptchaScore: 0
	},
	SubscriptionInfo: 
	{
		FormTemplateID: 0,
		SubscriptionInvoiceID: 0,
		ClientSubscriberId: String,
		SignupTypeID: 0,
		FrequencyID: 0,
		AutoRenew: False,
		CompanyID: 0,
		UserID: 0,
		ChapMemPayID: 0,
		MemberSubscriptionInvID: 0,
		Fields: 
		[
			{
				Name: String,
				Value: String
			}
		],
		CreatedBy: 0,
		UpdatedBy: 0,
		AptifyUpdateType: 0,
		RenewedMemberSubscriptionInvID: 0,
		ChapId: 0
	},
	CampaignInfo: 
	[
		{
			CampaignId: 0,
			CampaignName: String,
			Amount: 0,
			ChapPayID: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TransactionRecordID: 0,
	IsDuplicate: False,
	IsSuccessful: False,
	ErrorCode: String,
	Message: String,
	IsError: False
}