Billhighway Cloud API

<back to all web services

GetDonation

The following routes are available for this service:
GET/v1.1/Donations/Get/{id}
GET/v1.2/Donations/Get/{id}

export class CreditCardUsed
{
    public CardHolderName?: string;
    public Icon?: string;
    public CaptureSource?: string;
    public Last4Digits?: string;
    public Type?: string;

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

export class DonationLocation
{
    public Longitude?: number;
    public Latitude?: number;

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

export class DonationTransaction
{
    public Id?: number;
    public Status?: string;
    public DetailUri?: string;
    public CancelUri?: string;
    public CreatedBy?: number;
    public ClientId?: number;
    public GroupId?: number;

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

export class DonationReceiptsResponse
{
    public Id?: number;
    public Status?: string;
    public CampaignName?: string;
    public CampaignId?: number;
    public Date?: string;
    public Amount?: number;
    public CreditCard?: CreditCardUsed;
    public Location?: DonationLocation;
    public Transaction?: DonationTransaction;

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

export class GetDonation extends GetDonation implements IReturnLegacyException
{

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

TypeScript GetDonation 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.

GET /v1.1/Donations/Get/{id} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DonationReceiptsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <Amount>0</Amount>
  <CampaignId>0</CampaignId>
  <CampaignName>String</CampaignName>
  <CreditCard>
    <CaptureSource>String</CaptureSource>
    <CardHolderName>String</CardHolderName>
    <Icon>String</Icon>
    <Last4Digits>String</Last4Digits>
    <Type>String</Type>
  </CreditCard>
  <Date>String</Date>
  <Id>0</Id>
  <Location>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </Location>
  <Status>String</Status>
  <Transaction>
    <CancelUri>String</CancelUri>
    <ClientId>0</ClientId>
    <CreatedBy>0</CreatedBy>
    <DetailUri>String</DetailUri>
    <GroupId>0</GroupId>
    <Id>0</Id>
    <Status>String</Status>
  </Transaction>
</DonationReceiptsResponse>