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
import Foundation
import ServiceStack

public class Receipt : Receipt, IReturnLegacyException
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ReceiptResponse : Codable
{
    public var email:ReceiptSentStatus?
    public var sms:ReceiptSentStatus?

    required public init(){}
}

public class ReceiptSentStatus : Codable
{
    public var isSent:Bool?

    required public init(){}
}


Swift Receipt DTOs

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
	}
}