Billhighway Cloud API

CreditCardPaymentCollection

The following routes are available for this service:
POST	/payments/creditcard


export class CreditCardPaymentReply
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public TransactionId?: string;
    public ErrorCode?: number;
    public ErrorMessage?: string;

    public constructor(init?: Partial<CreditCardPaymentReply>) { (Object as any).assign(this, init); }
}

export class SubscriberFormField
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<SubscriberFormField>) { (Object as any).assign(this, init); }
}

export class SubscriptionParameters
{
    public FormTemplateID?: number;
    public SubscriptionInvoiceID?: number;
    public ClientSubscriberId?: string;
    public SignupTypeID?: number;
    public FrequencyID?: number;
    public AutoRenew?: boolean;
    public CompanyID?: number;
    public UserID?: number;
    public ChapMemPayID?: number;
    public MemberSubscriptionInvID?: number;
    public Fields?: SubscriberFormField[];
    public CreatedBy?: number;
    public UpdatedBy?: number;
    public AptifyUpdateType?: number;
    public RenewedMemberSubscriptionInvID?: number;
    public ChapId?: number;

    public constructor(init?: Partial<SubscriptionParameters>) { (Object as any).assign(this, init); }
}

export class CreditCardPayment extends CreditCardPayment
{
    public SubscriptionInfo?: SubscriptionParameters;

    public constructor(init?: Partial<CreditCardPayment>) { super(init); (Object as any).assign(this, init); }
}

export class CreditCardPaymentCollection
{
    public CreditCardPaymentList?: CreditCardPayment[];

    public constructor(init?: Partial<CreditCardPaymentCollection>) { (Object as any).assign(this, init); }
}

TypeScript CreditCardPaymentCollection 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 /payments/creditcard HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CreditCardPaymentList: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			GroupId: String,
			UserId: String,
			BhUserId: 0,
			Amount: String,
			AutoPay: False,
			CurrencyType: String,
			Country: String,
			CardReferenceOrCardNumber: String,
			StoreCardInfo: False,
			Address1: String,
			Address2: String,
			BillingCity: String,
			BillingState: String,
			PreferredEmailAddress: String,
			Memo: String,
			OpportunityId: String,
			ExpMonth: 0,
			ExpYear: 0,
			Cvv: String,
			PostalCode: String,
			Location: String,
			NameOnCard: String,
			CardType: String,
			InvoiceList: 
			[
				{
					ClassName: String,
					UniqueId: String,
					CreatedDateTime: 0001-01-01,
					ClientId: 0,
					Invoice: 0,
					AmountPaid: String
				}
			]
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ClassName: String,
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	TransactionId: String,
	ErrorCode: 0,
	ErrorMessage: String
}