Billhighway Cloud API

<back to all web services

Receipt

The following routes are available for this service:
POST/v1.1/receipts/send
POST/v1.2/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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /v1.1/receipts/send HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EmailReceiptRequest: 
	{
		From: String,
		Subject: String,
		Message: String,
		To: String
	},
	SmsReceiptRequest: 
	{
		Message: String,
		To: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Email: 
	{
		IsSent: False
	},
	Sms: 
	{
		IsSent: False
	}
}