Billhighway Cloud API

<back to all web services

Receipt

The following routes are available for this service:
POST/v1.2/receipts/send
POST/v1.1/receipts/send
ReceiptResponse Parameters:
NameParameterData TypeRequiredDescription
EmailformReceiptSentStatusNo
SmsformReceiptSentStatusNo
ReceiptSentStatus Parameters:
NameParameterData TypeRequiredDescription
IsSentformboolNo

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 /v1.2/receipts/send HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"UseDocGenService":false,"EmailReceiptRequest":{"From":"String","Subject":"String","Message":"String","To":"String"},"SmsReceiptRequest":{"Message":"String","To":"String"},"DocGenServiceReceiptRequest":{"TemplateType":0,"ClientId":0,"GroupId":0,"EmailTo":["String"],"Parameters":{"String":"String"}}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Email":{"IsSent":false},"Sms":{"IsSent":false}}