Billhighway Cloud API

crmRequest

import java.math.*
import java.util.*
import net.servicestack.client.*


open class crmRequest : crmRequest()
{
}

@DataContract(Namespace="www.billhighway.com/api")
open class crmRequestResponse : IHaveErrorField
{
    @DataMember
    var crmRequestResult:LegacyApiResponse? = null
}

@DataContract(Namespace="www.billhighway.com/api")
open class LegacyApiResponse : IHaveErrorField
{
    @DataMember
    var amount:BigDecimal? = null

    @DataMember
    var confirmationNumber:String? = null

    @DataMember
    var responseCode:String? = null

    @DataMember
    var responseDescription:String? = null

    @DataMember
    var resultCode:ResultCode? = null
}

enum class ResultCode(val value:Int)
{
    @SerializedName("0") Success(0),
    @SerializedName("-7") Duplicate(-7),
    @SerializedName("-6") NotAvailable(-6),
    @SerializedName("-5") NotFound(-5),
    @SerializedName("-4") GeneralError(-4),
    @SerializedName("-3") UnexpectedError(-3),
    @SerializedName("-2") CreditCardDeclined(-2),
    @SerializedName("-1") DataValidationFailure(-1),
}

Kotlin 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
	}
}