Billhighway Cloud API

crmRequest


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); }
}

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

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

export class crmRequest extends crmRequest
{

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

TypeScript crmRequest 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/crmRequest 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,
	activityID: 0,
	docNo: 0,
	docTypeID: 0,
	crmInfo: String
}

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

{
	crmRequestResult: 
	{
		amount: 0,
		confirmationNumber: String,
		responseCode: String,
		responseDescription: String,
		resultCode: 0
	}
}