| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| crmRequestResult | form | LegacyApiResponse | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| amount | form | decimal? | No | |
| confirmationNumber | form | string | No | |
| responseCode | form | string | No | |
| responseDescription | form | string | No | |
| resultCode | form | ResultCode | No |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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}}