Billhighway Cloud API

<back to all web services

CancelDonation

The following routes are available for this service:
POST/v1.1/Donations/Cancel
POST/v1.2/Donations/Cancel
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 CancelDonationResponse:
    status: Optional[str] = None


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

Python CancelDonation 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/Donations/Cancel HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CancelDonation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <ConfirmationNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ConfirmationNumber>
</CancelDonation>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CancelDonationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <Status>String</Status>
</CancelDonationResponse>