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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class Receipt extends Receipt implements IReturnLegacyException
    {
        
    }

    public static class ReceiptResponse
    {
        public ReceiptSentStatus Email = null;
        public ReceiptSentStatus Sms = null;
        
        public ReceiptSentStatus getEmail() { return Email; }
        public ReceiptResponse setEmail(ReceiptSentStatus value) { this.Email = value; return this; }
        public ReceiptSentStatus getSms() { return Sms; }
        public ReceiptResponse setSms(ReceiptSentStatus value) { this.Sms = value; return this; }
    }

    public static class ReceiptSentStatus
    {
        public Boolean IsSent = null;
        
        public Boolean getIsSent() { return IsSent; }
        public ReceiptSentStatus setIsSent(Boolean value) { this.IsSent = value; return this; }
    }

}

Java Receipt DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<Receipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <EmailReceiptRequest xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <From>String</From>
    <Message>String</Message>
    <Subject>String</Subject>
    <To>String</To>
  </EmailReceiptRequest>
  <SmsReceiptRequest xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <Message>String</Message>
    <To>String</To>
  </SmsReceiptRequest>
</Receipt>

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

<ReceiptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <Email>
    <IsSent>false</IsSent>
  </Email>
  <Sms>
    <IsSent>false</IsSent>
  </Sms>
</ReceiptResponse>