| POST | /donations/ach |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.Donations;
using ServiceStack.Text;
namespace BH.CloudAPI.Common4.DTO.Donations
{
public partial class DonationAchRequest
: DonationRequestBase, IDonationRequestWithDonorInfo
{
///<summary>
///Not required if MemberInfo is present on request
///</summary>
[ApiMember(Description="Not required if MemberInfo is present on request")]
public virtual DonationDonorInfo DonorInfo { get; set; }
///<summary>
///Not required if DonorInfo is present on request
///</summary>
[ApiMember(Description="Not required if DonorInfo is present on request")]
public virtual DonationMemberInfo MemberInfo { get; set; }
///<summary>
///Use GET /campaigns to retreive valid list of campaignIDs
///</summary>
[ApiMember(Description="Use GET /campaigns to retreive valid list of campaignIDs")]
public virtual int? CampaignId { get; set; }
///<summary>
///RoutingNumber and AccountNumber are not required if AchRef is provided
///</summary>
[ApiMember(Description="RoutingNumber and AccountNumber are not required if AchRef is provided")]
public virtual string AchRef { get; set; }
///<summary>
///Required if AchRef is not provided
///</summary>
[ApiMember(Description="Required if AchRef is not provided")]
public virtual string RoutingNumber { get; set; }
///<summary>
///Required if AchRef is not provided
///</summary>
[ApiMember(Description="Required if AchRef is not provided")]
public virtual string AccountNumber { get; set; }
}
public partial class DonationAchResponse
: IHaveErrorField
{
///<summary>
///Legacy ErrorCode
///</summary>
[ApiMember(Description="Legacy ErrorCode", ExcludeInSchema=true)]
[Ignore]
public virtual int ErrorCode { get; set; }
public virtual string ErrorMessage { get; set; }
public virtual bool IsError { get; set; }
///<summary>
///Donation Transaction ID
///</summary>
[ApiMember(Description="Donation Transaction ID")]
public virtual string TransactionId { get; set; }
}
public partial class DonationDonorInfo
{
///<summary>
///Name of donor. Maximum 100 characters. Format must be Firstname {space} Lastname.
///</summary>
[ApiMember(Description="Name of donor. Maximum 100 characters. Format must be Firstname {space} Lastname.", IsRequired=true, Name="FullName")]
public virtual string FullName { get; set; }
///<summary>
///Billing address. Maximum 100 characters.
///</summary>
[ApiMember(Description="Billing address. Maximum 100 characters.", IsRequired=true, Name="Address")]
public virtual string Address { get; set; }
///<summary>
///Billing city. Maximum 100 characters.
///</summary>
[ApiMember(Description="Billing city. Maximum 100 characters.", IsRequired=true, Name="City")]
public virtual string City { get; set; }
///<summary>
///Billing state. Two characters, must match valid US state code.
///</summary>
[ApiMember(Description="Billing state. Two characters, must match valid US state code.", IsRequired=true, Name="State")]
public virtual string State { get; set; }
///<summary>
///Credit Card billing address postal code. Maximum 10 characters.
///</summary>
[ApiMember(Description="Credit Card billing address postal code. Maximum 10 characters.", IsRequired=true, Name="PostalCode")]
public virtual string PostalCode { get; set; }
///<summary>
///Email address of donor. Maximum 100 characters. If provided, must be valid email format.
///</summary>
[ApiMember(Description="Email address of donor. Maximum 100 characters. If provided, must be valid email format.", Name="EmailAddress")]
public virtual string EmailAddress { get; set; }
///<summary>
///Preferred phone number. Maximum 12 characters.
///</summary>
[ApiMember(Description="Preferred phone number. Maximum 12 characters.", Name="Phone")]
public virtual string Phone { get; set; }
}
public partial class DonationMemberInfo
{
[ApiMember(IsRequired=true)]
public virtual int BhUserId { get; set; }
}
public partial class DonationRecurringInfo
{
///<summary>
///How often donation is collected automatically
///</summary>
[ApiMember(Description="How often donation is collected automatically", IsRequired=true, Name="Frequency")]
public virtual string Frequency { get; set; }
///<summary>
///Number of recurring donation cycles.
///</summary>
[ApiMember(Description="Number of recurring donation cycles.", IsRequired=true, Name="NumberOfOccurrences")]
public virtual int NumberOfOccurrences { get; set; }
///<summary>
///Allows the submitter to set a future date for the donation
///</summary>
[ApiMember(Description="Allows the submitter to set a future date for the donation", Name="FutureDonationDate")]
public virtual DateTime? FutureDonationDate { get; set; }
}
public partial class DonationRequestBase
{
///<summary>
///Client value for Group. String must already be configured in Billhighway system.
///</summary>
[ApiMember(Description="Client value for Group. String must already be configured in Billhighway system.", IsRequired=true, Name="GroupID")]
public virtual string GroupId { get; set; }
///<summary>
///Amount of the payment. Must be an amount less than $10,000,000.00.
///</summary>
[ApiMember(Description="Amount of the payment. Must be an amount less than $10,000,000.00.", IsRequired=true, Name="Amount")]
public virtual decimal Amount { get; set; }
///<summary>
///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
///</summary>
[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")]
public virtual string CurrencyCode { get; set; }
///<summary>
///Notes about the donation. Maximum 70 characters.
///</summary>
[ApiMember(Description="Notes about the donation. Maximum 70 characters.", Name="Memo")]
public virtual string Memo { get; set; }
[ApiMember]
public virtual DonationRecurringInfo DonationRecurringInfo { get; set; }
///<summary>
///Custom fields
///</summary>
[ApiMember(Description="Custom fields", Name="MetaData")]
public virtual JsonObject MetaData { get; set; }
}
}
namespace ServiceStack.Text
{
public partial class JsonObject
: Dictionary<string, string>
{
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"DonorInfo":{"FullName":"String","Address":"String","City":"String","State":"String","PostalCode":"String","EmailAddress":"String","Phone":"String"},"MemberInfo":{"BhUserId":0},"CampaignId":0,"AchRef":"String","RoutingNumber":"String","AccountNumber":"String","GroupId":"String","Amount":0,"CurrencyCode":"String","Memo":"String","DonationRecurringInfo":{"Frequency":"String","NumberOfOccurrences":0,"FutureDonationDate":"0001-01-01T00:00:00.0000000"},"MetaData":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ErrorCode":0,"ErrorMessage":"String","IsError":false,"TransactionId":"String"}