Billhighway Cloud API

crmRequest

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

public class dtos
{

    public static class crmRequest extends crmRequest
    {
        
    }

    @DataContract(Namespace="www.billhighway.com/api")
    public static class crmRequestResponse implements IHaveErrorField
    {
        @DataMember
        public LegacyApiResponse crmRequestResult = null;
        
        public LegacyApiResponse getCrmRequestResult() { return crmRequestResult; }
        public crmRequestResponse setCrmRequestResult(LegacyApiResponse value) { this.crmRequestResult = value; return this; }
    }

    @DataContract(Namespace="www.billhighway.com/api")
    public static class LegacyApiResponse implements IHaveErrorField
    {
        @DataMember
        public BigDecimal amount = null;

        @DataMember
        public String confirmationNumber = null;

        @DataMember
        public String responseCode = null;

        @DataMember
        public String responseDescription = null;

        @DataMember
        public ResultCode resultCode = null;
        
        public BigDecimal getAmount() { return amount; }
        public LegacyApiResponse setAmount(BigDecimal value) { this.amount = value; return this; }
        public String getConfirmationNumber() { return confirmationNumber; }
        public LegacyApiResponse setConfirmationNumber(String value) { this.confirmationNumber = value; return this; }
        public String getResponseCode() { return responseCode; }
        public LegacyApiResponse setResponseCode(String value) { this.responseCode = value; return this; }
        public String getResponseDescription() { return responseDescription; }
        public LegacyApiResponse setResponseDescription(String value) { this.responseDescription = value; return this; }
        public ResultCode getResultCode() { return resultCode; }
        public LegacyApiResponse setResultCode(ResultCode value) { this.resultCode = value; return this; }
    }

    public static enum ResultCode
    {
        @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);

        private final int value;
        ResultCode(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java crmRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/crmRequest HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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