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

export class ReceiptSentStatus
{
    public IsSent?: boolean;

    public constructor(init?: Partial<ReceiptSentStatus>) { (Object as any).assign(this, init); }
}

export class ReceiptResponse
{
    public Email?: ReceiptSentStatus;
    public Sms?: ReceiptSentStatus;

    public constructor(init?: Partial<ReceiptResponse>) { (Object as any).assign(this, init); }
}

export class Receipt extends Receipt implements IReturnLegacyException
{

    public constructor(init?: Partial<Receipt>) { super(init); (Object as any).assign(this, init); }
}

TypeScript Receipt DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

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