Billhighway Cloud API

<back to all web services

BillMeLaterSubscription

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

public class dtos
{

    public static class BillMeLaterSubscription
    {
        public ApiClientHeader Header = null;
        public SubscriptionParameters SubscriptionInfo = null;
        public ArrayList<CampaignInformation> CampaignInfo = null;
        
        public ApiClientHeader getHeader() { return Header; }
        public BillMeLaterSubscription setHeader(ApiClientHeader value) { this.Header = value; return this; }
        public SubscriptionParameters getSubscriptionInfo() { return SubscriptionInfo; }
        public BillMeLaterSubscription setSubscriptionInfo(SubscriptionParameters value) { this.SubscriptionInfo = value; return this; }
        public ArrayList<CampaignInformation> getCampaignInfo() { return CampaignInfo; }
        public BillMeLaterSubscription setCampaignInfo(ArrayList<CampaignInformation> value) { this.CampaignInfo = value; return this; }
    }

    public static class ApiClientHeader
    {
        public Integer ClientId = null;
        public String Referrer = null;
        public String IpAddress = null;
        public Integer LoggedInUserId = null;
        public Integer GroupId = null;
        public String Task = null;
        public String Machine = null;
        public String Location = null;
        public Integer CreatedBy = null;
        public Integer CampaignId = null;
        public BigDecimal ReCaptchaScore = null;
        
        public Integer getClientId() { return ClientId; }
        public ApiClientHeader setClientId(Integer value) { this.ClientId = value; return this; }
        public String getReferrer() { return Referrer; }
        public ApiClientHeader setReferrer(String value) { this.Referrer = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public ApiClientHeader setIpAddress(String value) { this.IpAddress = value; return this; }
        public Integer getLoggedInUserId() { return LoggedInUserId; }
        public ApiClientHeader setLoggedInUserId(Integer value) { this.LoggedInUserId = value; return this; }
        public Integer getGroupId() { return GroupId; }
        public ApiClientHeader setGroupId(Integer value) { this.GroupId = value; return this; }
        public String getTask() { return Task; }
        public ApiClientHeader setTask(String value) { this.Task = value; return this; }
        public String getMachine() { return Machine; }
        public ApiClientHeader setMachine(String value) { this.Machine = value; return this; }
        public String getLocation() { return Location; }
        public ApiClientHeader setLocation(String value) { this.Location = value; return this; }
        public Integer getCreatedBy() { return CreatedBy; }
        public ApiClientHeader setCreatedBy(Integer value) { this.CreatedBy = value; return this; }
        public Integer getCampaignId() { return CampaignId; }
        public ApiClientHeader setCampaignId(Integer value) { this.CampaignId = value; return this; }
        public BigDecimal getReCaptchaScore() { return ReCaptchaScore; }
        public ApiClientHeader setReCaptchaScore(BigDecimal value) { this.ReCaptchaScore = value; return this; }
    }

    public static class SubscriptionParameters
    {
        public Integer FormTemplateID = null;
        public Integer SubscriptionInvoiceID = null;
        public String ClientSubscriberId = null;
        public Integer SignupTypeID = null;
        public Integer FrequencyID = null;
        public Boolean AutoRenew = null;
        public Long CompanyID = null;
        public Integer UserID = null;
        public Long ChapMemPayID = null;
        public Long MemberSubscriptionInvID = null;
        public ArrayList<SubscriberFormField> Fields = null;
        public Integer CreatedBy = null;
        public Integer UpdatedBy = null;
        public Integer AptifyUpdateType = null;
        public Long RenewedMemberSubscriptionInvID = null;
        public Integer ChapId = null;
        
        public Integer getFormTemplateID() { return FormTemplateID; }
        public SubscriptionParameters setFormTemplateID(Integer value) { this.FormTemplateID = value; return this; }
        public Integer getSubscriptionInvoiceID() { return SubscriptionInvoiceID; }
        public SubscriptionParameters setSubscriptionInvoiceID(Integer value) { this.SubscriptionInvoiceID = value; return this; }
        public String getClientSubscriberId() { return ClientSubscriberId; }
        public SubscriptionParameters setClientSubscriberId(String value) { this.ClientSubscriberId = value; return this; }
        public Integer getSignupTypeID() { return SignupTypeID; }
        public SubscriptionParameters setSignupTypeID(Integer value) { this.SignupTypeID = value; return this; }
        public Integer getFrequencyID() { return FrequencyID; }
        public SubscriptionParameters setFrequencyID(Integer value) { this.FrequencyID = value; return this; }
        public Boolean isAutoRenew() { return AutoRenew; }
        public SubscriptionParameters setAutoRenew(Boolean value) { this.AutoRenew = value; return this; }
        public Long getCompanyID() { return CompanyID; }
        public SubscriptionParameters setCompanyID(Long value) { this.CompanyID = value; return this; }
        public Integer getUserID() { return UserID; }
        public SubscriptionParameters setUserID(Integer value) { this.UserID = value; return this; }
        public Long getChapMemPayID() { return ChapMemPayID; }
        public SubscriptionParameters setChapMemPayID(Long value) { this.ChapMemPayID = value; return this; }
        public Long getMemberSubscriptionInvID() { return MemberSubscriptionInvID; }
        public SubscriptionParameters setMemberSubscriptionInvID(Long value) { this.MemberSubscriptionInvID = value; return this; }
        public ArrayList<SubscriberFormField> getFields() { return Fields; }
        public SubscriptionParameters setFields(ArrayList<SubscriberFormField> value) { this.Fields = value; return this; }
        public Integer getCreatedBy() { return CreatedBy; }
        public SubscriptionParameters setCreatedBy(Integer value) { this.CreatedBy = value; return this; }
        public Integer getUpdatedBy() { return UpdatedBy; }
        public SubscriptionParameters setUpdatedBy(Integer value) { this.UpdatedBy = value; return this; }
        public Integer getAptifyUpdateType() { return AptifyUpdateType; }
        public SubscriptionParameters setAptifyUpdateType(Integer value) { this.AptifyUpdateType = value; return this; }
        public Long getRenewedMemberSubscriptionInvID() { return RenewedMemberSubscriptionInvID; }
        public SubscriptionParameters setRenewedMemberSubscriptionInvID(Long value) { this.RenewedMemberSubscriptionInvID = value; return this; }
        public Integer getChapId() { return ChapId; }
        public SubscriptionParameters setChapId(Integer value) { this.ChapId = value; return this; }
    }

    public static class SubscriberFormField
    {
        public String Name = null;
        public String Value = null;
        
        public String getName() { return Name; }
        public SubscriberFormField setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public SubscriberFormField setValue(String value) { this.Value = value; return this; }
    }

    public static class CampaignInformation
    {
        public Integer CampaignId = null;
        public String CampaignName = null;
        public BigDecimal Amount = null;
        public String ChapPayID = null;
        
        public Integer getCampaignId() { return CampaignId; }
        public CampaignInformation setCampaignId(Integer value) { this.CampaignId = value; return this; }
        public String getCampaignName() { return CampaignName; }
        public CampaignInformation setCampaignName(String value) { this.CampaignName = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public CampaignInformation setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getChapPayID() { return ChapPayID; }
        public CampaignInformation setChapPayID(String value) { this.ChapPayID = value; return this; }
    }

    public static class BillMePaymentResult extends BillMeCloudServiceResponse
    {
        public Long TransactionRecordID = null;
        
        public Long getTransactionRecordID() { return TransactionRecordID; }
        public BillMePaymentResult setTransactionRecordID(Long value) { this.TransactionRecordID = value; return this; }
    }

    public static class BillMeCloudServiceResponse
    {
        public Boolean IsDuplicate = null;
        public Boolean IsSuccessful = null;
        public String ErrorCode = null;
        public String Message = null;
        public Boolean IsError = null;
        
        public Boolean getIsDuplicate() { return IsDuplicate; }
        public BillMeCloudServiceResponse setIsDuplicate(Boolean value) { this.IsDuplicate = value; return this; }
        public Boolean getIsSuccessful() { return IsSuccessful; }
        public BillMeCloudServiceResponse setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BillMeCloudServiceResponse setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getMessage() { return Message; }
        public BillMeCloudServiceResponse setMessage(String value) { this.Message = value; return this; }
        public Boolean getIsError() { return IsError; }
        public BillMeCloudServiceResponse setIsError(Boolean value) { this.IsError = value; return this; }
    }

}

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