Billhighway Cloud API

<back to all web services

DonationAchRequest

The following routes are available for this service:
POST/donations/ach
import java.math.*
import java.util.*
import net.servicestack.client.*


open class DonationAchRequest : DonationRequestBase(), IDonationRequestWithDonorInfo
{
    /**
    * Not required if MemberInfo is present on request
    */
    @ApiMember(Description="Not required if MemberInfo is present on request")
    var DonorInfo:DonationDonorInfo? = null

    /**
    * Not required if DonorInfo is present on request
    */
    @ApiMember(Description="Not required if DonorInfo is present on request")
    var MemberInfo:DonationMemberInfo? = null

    /**
    * Use GET /campaigns to retreive valid list of campaignIDs
    */
    @ApiMember(Description="Use GET /campaigns to retreive valid list of campaignIDs")
    var CampaignId:Int? = null

    /**
    * RoutingNumber and AccountNumber are not required if AchRef is provided
    */
    @ApiMember(Description="RoutingNumber and AccountNumber are not required if AchRef is provided")
    var AchRef:String? = null

    /**
    * Required if AchRef is not provided
    */
    @ApiMember(Description="Required if AchRef is not provided")
    var RoutingNumber:String? = null

    /**
    * Required if AchRef is not provided
    */
    @ApiMember(Description="Required if AchRef is not provided")
    var AccountNumber:String? = null
}

open class DonationRequestBase
{
    /**
    * Client value for Group. String must already be configured in Billhighway system.
    */
    @ApiMember(Description="Client value for Group. String must already be configured in Billhighway system.", IsRequired=true, Name="GroupID")
    var GroupId:String? = null

    /**
    * Amount of the payment. Must be an amount less than $10,000,000.00.
    */
    @ApiMember(Description="Amount of the payment. Must be an amount less than $10,000,000.00.", IsRequired=true, Name="Amount")
    var Amount:BigDecimal? = null

    /**
    * The currency the payment is being made in. Three digit currency code (see ISO 4217) for a valid currency supported by Billhighway.  Defaults to USD
    */
    @ApiMember(Description="The currency the payment is being made in. Three digit currency code (see ISO 4217) for a valid currency supported by Billhighway.  Defaults to USD", ExcludeInSchema=true, Name="CurrencyCode")
    var CurrencyCode:String? = null

    /**
    * Notes about the donation. Maximum 70 characters.
    */
    @ApiMember(Description="Notes about the donation. Maximum 70 characters.", Name="Memo")
    var Memo:String? = null

    @ApiMember()
    var DonationRecurringInfo:DonationRecurringInfo? = null

    /**
    * Custom fields
    */
    @ApiMember(Description="Custom fields", Name="MetaData")
    var MetaData:JsonObject? = null
}

open class DonationRecurringInfo
{
    /**
    * How often donation is collected automatically
    */
    @ApiMember(Description="How often donation is collected automatically", IsRequired=true, Name="Frequency")
    var Frequency:String? = null

    /**
    * Number of recurring donation cycles.
    */
    @ApiMember(Description="Number of recurring donation cycles.", IsRequired=true, Name="NumberOfOccurrences")
    var NumberOfOccurrences:Int? = null

    /**
    * Allows the submitter to set a future date for the donation
    */
    @ApiMember(Description="Allows the submitter to set a future date for the donation", Name="FutureDonationDate")
    var FutureDonationDate:Date? = null
}

open class JsonObject : HashMap<String,String>()
{
}

open class DonationDonorInfo
{
    /**
    * Name of donor. Maximum 100 characters. Format must be Firstname {space} Lastname.
    */
    @ApiMember(Description="Name of donor. Maximum 100 characters. Format must be Firstname {space} Lastname.", IsRequired=true, Name="FullName")
    var FullName:String? = null

    /**
    * Billing address. Maximum 100 characters.
    */
    @ApiMember(Description="Billing address. Maximum 100 characters.", IsRequired=true, Name="Address")
    var Address:String? = null

    /**
    * Billing city. Maximum 100 characters.
    */
    @ApiMember(Description="Billing city. Maximum 100 characters.", IsRequired=true, Name="City")
    var City:String? = null

    /**
    * Billing state. Two characters, must match valid US state code.
    */
    @ApiMember(Description="Billing state. Two characters, must match valid US state code.", IsRequired=true, Name="State")
    var State:String? = null

    /**
    * Credit Card billing address postal code. Maximum 10 characters.
    */
    @ApiMember(Description="Credit Card billing address postal code. Maximum 10 characters.", IsRequired=true, Name="PostalCode")
    var PostalCode:String? = null

    /**
    * Email address of donor. Maximum 100 characters. If provided, must be valid email format.
    */
    @ApiMember(Description="Email address of donor. Maximum 100 characters. If provided, must be valid email format.", Name="EmailAddress")
    var EmailAddress:String? = null

    /**
    * Preferred phone number. Maximum 12 characters.
    */
    @ApiMember(Description="Preferred phone number. Maximum 12 characters.", Name="Phone")
    var Phone:String? = null
}

open class DonationMemberInfo
{
    @ApiMember(IsRequired=true)
    var BhUserId:Int? = null
}

open class DonationAchResponse : IHaveErrorField
{
    /**
    * Legacy ErrorCode
    */
    @ApiMember(Description="Legacy ErrorCode", ExcludeInSchema=true)
    @Ignore()
    var ErrorCode:Int? = null

    var ErrorMessage:String? = null
    var IsError:Boolean? = null
    /**
    * Donation Transaction ID
    */
    @ApiMember(Description="Donation Transaction ID")
    var TransactionId:String? = null
}

Kotlin DonationAchRequest 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 /donations/ach HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DonationAchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Donations">
  <Amount>0</Amount>
  <CurrencyCode>String</CurrencyCode>
  <DonationRecurringInfo>
    <Frequency>String</Frequency>
    <FutureDonationDate>0001-01-01T00:00:00</FutureDonationDate>
    <NumberOfOccurrences>0</NumberOfOccurrences>
  </DonationRecurringInfo>
  <GroupId>String</GroupId>
  <Memo>String</Memo>
  <MetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MetaData>
  <AccountNumber>String</AccountNumber>
  <AchRef>String</AchRef>
  <CampaignId>0</CampaignId>
  <DonorInfo>
    <Address>String</Address>
    <City>String</City>
    <EmailAddress>String</EmailAddress>
    <FullName>String</FullName>
    <Phone>String</Phone>
    <PostalCode>String</PostalCode>
    <State>String</State>
  </DonorInfo>
  <MemberInfo>
    <BhUserId>0</BhUserId>
  </MemberInfo>
  <RoutingNumber>String</RoutingNumber>
</DonationAchRequest>

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

<DonationAchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Donations">
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <IsError>false</IsError>
  <TransactionId>String</TransactionId>
</DonationAchResponse>