Billhighway Cloud API

ccPaymentByGroup


export enum ResultCode
{
    Success = 0,
    Duplicate = -7,
    NotAvailable = -6,
    NotFound = -5,
    GeneralError = -4,
    UnexpectedError = -3,
    CreditCardDeclined = -2,
    DataValidationFailure = -1,
}

// @DataContract(Namespace="www.billhighway.com/api")
export class LegacyApiResponse implements IHaveErrorField
{
    // @DataMember
    public amount?: number;

    // @DataMember
    public confirmationNumber?: string;

    // @DataMember
    public responseCode?: string;

    // @DataMember
    public responseDescription?: string;

    // @DataMember
    public resultCode?: ResultCode;

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

export class SoapArrayList extends ArrayList
{

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

// @DataContract(Namespace="www.billhighway.com/api")
export class ccPaymentByGroupResponse extends LegacyApiResponse
{
    // @DataMember(Name="ccPaymentByGroupResult")
    public Results?: SoapArrayList;

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

export class ccPaymentByGroup extends ccPaymentByGroup implements ICanBeRecurring
{

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

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

{
	apiKey: String,
	featureID: 0,
	clientID: 0,
	groupID: 0,
	Amount: 0,
	nameOnCard: String,
	cardType: String,
	cardNumber: String,
	expMonth: String,
	expYear: String,
	cvv: String,
	address: String,
	city: String,
	state: String,
	postalCode: String,
	email: String,
	memo: String,
	occurs: String,
	numberOfOccurrences: String
}

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

{
	ccPaymentByGroupResult: 
	[
		0,
		0,
		0,
		String,
		String,
		0
	],
	amount: 0,
	confirmationNumber: String,
	responseCode: String,
	responseDescription: String,
	resultCode: 0
}