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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardUsed:
    card_holder_name: Optional[str] = None
    icon: Optional[str] = None
    capture_source: Optional[str] = None
    last4_digits: Optional[str] = None
    type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DonationLocation:
    longitude: Optional[float] = None
    latitude: Optional[float] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DonationTransaction:
    id: Optional[int] = None
    status: Optional[str] = None
    detail_uri: Optional[str] = None
    cancel_uri: Optional[str] = None
    created_by: Optional[int] = None
    client_id: Optional[int] = None
    group_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DonationReceiptsResponse:
    id: Optional[int] = None
    status: Optional[str] = None
    campaign_name: Optional[str] = None
    campaign_id: Optional[int] = None
    date: Optional[str] = None
    amount: Optional[Decimal] = None
    credit_card: Optional[CreditCardUsed] = None
    location: Optional[DonationLocation] = None
    transaction: Optional[DonationTransaction] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDonation(GetDonation, IReturnLegacyException):
    pass

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