Billhighway Cloud API

<back to all web services

DonationRedirectUrl

The following routes are available for this service:
POST/v1.1/donations/redirecturl
POST/v1.2/donations/redirecturl
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 DonationRedirectUrlResponse:
    redirect_url: Optional[str] = None


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

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

<DonationRedirectUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <AuthorizationParameter xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</AuthorizationParameter>
  <CampaignName xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CampaignName>
  <DonationsTokenResponse xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <Amount>0</Amount>
    <CreditCard>
      <CaptureSource>String</CaptureSource>
      <CardHolderName>String</CardHolderName>
      <Icon>String</Icon>
      <Last4Digits>String</Last4Digits>
      <Type>String</Type>
    </CreditCard>
    <DonationToken>String</DonationToken>
  </DonationsTokenResponse>
  <Location xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </Location>
  <RedirectToken xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</RedirectToken>
  <Signature xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Signature>
</DonationRedirectUrl>

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

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