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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO
Imports BH.CloudAPI.Common.DTO

Namespace Global

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class ReceiptResponse
            Public Overridable Property Email As ReceiptSentStatus
            Public Overridable Property Sms As ReceiptSentStatus
        End Class

        Public Partial Class ReceiptSentStatus
            Public Overridable Property IsSent As Boolean
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class Receipt
            Inherits Receipt
            Implements IReturnLegacyException
        End Class
    End Namespace
End Namespace

VB.NET Receipt DTOs

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

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

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