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}
namespace BH.CloudAPI.Common.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CreditCardUsed() = 
        member val CardHolderName:String = null with get,set
        member val Icon:String = null with get,set
        member val CaptureSource:String = null with get,set
        member val Last4Digits:String = null with get,set
        member val Type:String = null with get,set

    [<AllowNullLiteral>]
    type DonationLocation() = 
        member val Longitude:Double = new Double() with get,set
        member val Latitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type DonationTransaction() = 
        member val Id:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val DetailUri:String = null with get,set
        member val CancelUri:String = null with get,set
        member val CreatedBy:Int32 = new Int32() with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type DonationReceiptsResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val CampaignName:String = null with get,set
        member val CampaignId:Int32 = new Int32() with get,set
        member val Date:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val CreditCard:CreditCardUsed = null with get,set
        member val Location:DonationLocation = null with get,set
        member val Transaction:DonationTransaction = null with get,set

    [<AllowNullLiteral>]
    type GetDonation() = 
        inherit GetDonation()

F# GetDonation DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}