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

namespace BH.CloudAPI.Common.DTO
{
    public partial class ReceiptResponse
    {
        public virtual ReceiptSentStatus Email { get; set; }
        public virtual ReceiptSentStatus Sms { get; set; }
    }

    public partial class ReceiptSentStatus
    {
        public virtual bool IsSent { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class Receipt
        : Receipt, IReturnLegacyException
    {
    }

}

C# 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>