Billhighway Cloud API

crmRequest

**crmRequestResponse** Parameters:
Name	Parameter	Data Type	Required	Description
crmRequestResult	form	LegacyApiResponse	No

**LegacyApiResponse** Parameters:
Name	Parameter	Data Type	Required
amount	form	decimal?	No
confirmationNumber	form	string	No
responseCode	form	string	No
responseDescription	form	string	No
resultCode	form	ResultCode	No

**ResultCode** Enum:
Name	Value
Success	0
Duplicate	-7
NotAvailable	-6
NotFound	-5
GeneralError	-4
UnexpectedError	-3
CreditCardDeclined	-2
DataValidationFailure	-1

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>