Billhighway Cloud API

<back to all web services

CreditCardPaymentCollection

The following routes are available for this service:
POST/payments/creditcard
CreditCardPaymentCollection Parameters:
NameParameterData TypeRequiredDescription
CreditCardPaymentListbodyList<CreditCardPayment>No
CreditCardPayment Parameters:
NameParameterData TypeRequiredDescription
SubscriptionInfoformSubscriptionParametersNo
SubscriptionParameters Parameters:
NameParameterData TypeRequiredDescription
FormTemplateIDformintNo
SubscriptionInvoiceIDformintNo
ClientSubscriberIdformstringNo
SignupTypeIDformintNo
FrequencyIDformintNo
AutoRenewformboolNo
CompanyIDformlongNo
UserIDformintNo
ChapMemPayIDformlongNo
MemberSubscriptionInvIDformlongNo
FieldsformList<SubscriberFormField>No
CreatedByformintNo
UpdatedByformintNo
AptifyUpdateTypeformintNo
RenewedMemberSubscriptionInvIDformlongNo
ChapIdformintNo
SubscriberFormField Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
CreditCardPaymentReply Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
TransactionIdformstringNo
ErrorCodeformintNo
ErrorMessageformstringNo

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
}