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

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

{"Id":0,"Status":"String","CampaignName":"String","CampaignId":0,"Date":"String","Amount":0,"CreditCard":{"CardHolderName":"String","Icon":"String","CaptureSource":"String","Last4Digits":"String","Type":"String"},"Location":{"Longitude":0,"Latitude":0},"Transaction":{"Id":0,"Status":"String","DetailUri":"String","CancelUri":"String","CreatedBy":0,"ClientId":0,"GroupId":0}}