| POST | /signup/api/nat/{natID}/group/{groupID}/subscription | ||
|---|---|---|---|
| POST | /signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/subscription |
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.Subscriptions.Request;
using BH.CloudAPI.Common4.DTO.Subscriptions;
using BH.CloudAPI.Common4.DTO.SalesForce;
using BH.CloudAPI.Common4.DTO.Subscriptions.Response;
namespace BH.CloudAPI.Common4.DTO.SalesForce
{
public partial class SubscriberFormField
{
public virtual string Name { get; set; }
public virtual string Value { get; set; }
}
}
namespace BH.CloudAPI.Common4.DTO.Subscriptions
{
public partial class AchPaymentInformation
{
public virtual string AccountHolderName { get; set; }
public virtual string CheckNumber { get; set; }
public virtual string RoutingNumber { get; set; }
public virtual string AccountNumber { get; set; }
public virtual string AccountType { get; set; }
}
public partial class BillMeLaterInformation
{
public BillMeLaterInformation()
{
Campaigns = new List<CampaignInformation>{};
}
public virtual bool IsBillMeLaterPayment { get; set; }
public virtual bool IsBillMeLaterSubscription { get; set; }
public virtual int MemberSubscriptionInvId { get; set; }
public virtual List<CampaignInformation> Campaigns { get; set; }
}
public partial class CampaignInformation
{
public virtual int CampaignId { get; set; }
public virtual string CampaignName { get; set; }
public virtual decimal Amount { get; set; }
public virtual string ChapPayID { get; set; }
}
public partial class CcPaymentInformation
{
public virtual string CardNumber { get; set; }
public virtual string Cvv { get; set; }
public virtual int ExpMonth { get; set; }
public virtual int ExpYear { get; set; }
public virtual string CardholderName { get; set; }
public virtual string Country { get; set; }
public virtual string BillingAddress { get; set; }
public virtual string Address1 { get; set; }
public virtual string Address2 { get; set; }
public virtual string City { get; set; }
public virtual string StateProvince { get; set; }
public virtual string PostalCode { get; set; }
}
public partial class ClientVerification
{
public virtual string Provider { get; set; }
public virtual string VerificationCode { get; set; }
}
public partial class SubscriberFormData
{
public SubscriberFormData()
{
FormFields = new List<SubscriberFormField>{};
}
public virtual int FormTemplateID { get; set; }
public virtual int SignupTypeID { get; set; }
public virtual List<SubscriberFormField> FormFields { get; set; }
}
public partial class SubscriptionInformation
{
public virtual int FrequencyID { get; set; }
public virtual int SubscriptionInvoiceID { get; set; }
public virtual bool AutoRenew { get; set; }
public virtual bool HasAgreedToTerms { get; set; }
public virtual string ClientSubscriberId { get; set; }
public virtual int RenewedMemberSubscriptionInvID { get; set; }
}
}
namespace BH.CloudAPI.Common4.DTO.Subscriptions.Request
{
public partial class SubscriptionCreateRq
{
public SubscriptionCreateRq()
{
Campaigns = new List<CampaignInformation>{};
}
public virtual int NatID { get; set; }
public virtual int GroupID { get; set; }
public virtual string ClientGroupID { get; set; }
public virtual string UserType { get; set; }
public virtual string UserID { get; set; }
public virtual SubscriberFormData FormData { get; set; }
public virtual SubscriptionInformation SubscriptionInfo { get; set; }
public virtual ClientVerification VerificationInfo { get; set; }
public virtual CcPaymentInformation CcPaymentInfo { get; set; }
public virtual AchPaymentInformation AchPaymentInfo { get; set; }
public virtual BillMeLaterInformation BillMeLater { get; set; }
public virtual List<CampaignInformation> Campaigns { get; set; }
}
}
namespace BH.CloudAPI.Common4.DTO.Subscriptions.Response
{
public partial class SubscriptionCreateRs
{
public virtual bool IsSuccess { get; set; }
public virtual string UniqueId { get; set; }
public virtual DateTime CreatedDateTime { get; set; }
public virtual int ClientId { get; set; }
public virtual int BillhighwayUserId { get; set; }
public virtual string ConfirmationNumber { get; set; }
public virtual long PaymentConfirmationNumber { get; set; }
public virtual long SubscriptionConfirmationNumber { get; set; }
public virtual string ErrorCode { get; set; }
public virtual string Message { get; set; }
public virtual string FriendlyMessage { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /signup/api/nat/{natID}/group/{groupID}/subscription HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
NatID: 0,
GroupID: 0,
ClientGroupID: String,
UserType: String,
UserID: String,
FormData:
{
FormTemplateID: 0,
SignupTypeID: 0,
FormFields:
[
{
FormTemplateFieldID: 0,
Name: String,
Value: String
}
]
},
SubscriptionInfo:
{
FrequencyID: 0,
SubscriptionInvoiceID: 0,
AutoRenew: False,
HasAgreedToTerms: False,
ClientSubscriberId: String,
RenewedMemberSubscriptionInvID: 0
},
VerificationInfo:
{
Provider: String,
VerificationCode: String
},
CcPaymentInfo:
{
CardNumber: String,
Cvv: String,
ExpMonth: 0,
ExpYear: 0,
CardholderName: String,
Country: String,
BillingAddress: String,
Address1: String,
Address2: String,
City: String,
StateProvince: String,
PostalCode: String
},
AchPaymentInfo:
{
AccountHolderName: String,
CheckNumber: String,
RoutingNumber: String,
AccountNumber: String,
AccountType: String
},
BillMeLater:
{
IsBillMeLaterPayment: False,
IsBillMeLaterSubscription: False,
MemberSubscriptionInvId: 0,
Campaigns:
[
{
CampaignId: 0,
CampaignName: String,
Amount: 0,
ChapPayID: String
}
]
},
Campaigns:
[
{
CampaignId: 0,
CampaignName: String,
Amount: 0,
ChapPayID: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IsSuccess: False,
UniqueId: String,
CreatedDateTime: 0001-01-01,
ClientId: 0,
BillhighwayUserId: 0,
ConfirmationNumber: String,
PaymentConfirmationNumber: 0,
SubscriptionConfirmationNumber: 0,
ErrorCode: String,
Message: String,
FriendlyMessage: String
}