Billhighway Cloud API

<back to all web services

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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/crmRequest HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<crmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SOAP">
  <apiKey xmlns="www.billhighway.com/api">String</apiKey>
  <featureID xmlns="www.billhighway.com/api">0</featureID>
  <clientID xmlns="www.billhighway.com/api">0</clientID>
  <groupID xmlns="www.billhighway.com/api">0</groupID>
  <activityID xmlns="www.billhighway.com/api">0</activityID>
  <docNo xmlns="www.billhighway.com/api">0</docNo>
  <docTypeID xmlns="www.billhighway.com/api">0</docTypeID>
  <crmInfo xmlns="www.billhighway.com/api">String</crmInfo>
</crmRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<crmRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <crmRequestResult>
    <amount>0</amount>
    <confirmationNumber>String</confirmationNumber>
    <responseCode>String</responseCode>
    <responseDescription>String</responseDescription>
    <resultCode>Success</resultCode>
  </crmRequestResult>
</crmRequestResponse>