| POST | /donations/ach |
|---|
export class DonationRecurringInfo
{
/**
* How often donation is collected automatically
*/
// @ApiMember(Description="How often donation is collected automatically", IsRequired=true, Name="Frequency")
public Frequency?: string;
/**
* Number of recurring donation cycles.
*/
// @ApiMember(Description="Number of recurring donation cycles.", IsRequired=true, Name="NumberOfOccurrences")
public NumberOfOccurrences: number;
/**
* 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")
public FutureDonationDate?: string;
public constructor(init?: Partial<DonationRecurringInfo>) { (Object as any).assign(this, init); }
}
export class Dictionary<T> { [Key: string]: T; }
export class JsonObject extends Dictionary<string>
{
public constructor(init?: Partial<JsonObject>) { super(); (Object as any).assign(this, init); }
}
export 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")
public GroupId?: string;
/**
* 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")
public Amount: number;
/**
* 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")
public CurrencyCode?: string;
/**
* Notes about the donation. Maximum 70 characters.
*/
// @ApiMember(Description="Notes about the donation. Maximum 70 characters.", Name="Memo")
public Memo?: string;
// @ApiMember()
public DonationRecurringInfo?: DonationRecurringInfo;
/**
* Custom fields
*/
// @ApiMember(Description="Custom fields", Name="MetaData")
public MetaData?: JsonObject;
public constructor(init?: Partial<DonationRequestBase>) { (Object as any).assign(this, init); }
}
export class DonationAchResponse implements IHaveErrorField
{
/**
* Legacy ErrorCode
*/
// @ApiMember(Description="Legacy ErrorCode", ExcludeInSchema=true)
// @Ignore()
public ErrorCode?: number;
public ErrorMessage?: string;
public IsError?: boolean;
/**
* Donation Transaction ID
*/
// @ApiMember(Description="Donation Transaction ID")
public TransactionId?: string;
public constructor(init?: Partial<DonationAchResponse>) { (Object as any).assign(this, init); }
}
export 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")
public FullName?: string;
/**
* Billing address. Maximum 100 characters.
*/
// @ApiMember(Description="Billing address. Maximum 100 characters.", IsRequired=true, Name="Address")
public Address?: string;
/**
* Billing city. Maximum 100 characters.
*/
// @ApiMember(Description="Billing city. Maximum 100 characters.", IsRequired=true, Name="City")
public City?: string;
/**
* 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")
public State?: string;
/**
* Credit Card billing address postal code. Maximum 10 characters.
*/
// @ApiMember(Description="Credit Card billing address postal code. Maximum 10 characters.", IsRequired=true, Name="PostalCode")
public PostalCode?: string;
/**
* 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")
public EmailAddress?: string;
/**
* Preferred phone number. Maximum 12 characters.
*/
// @ApiMember(Description="Preferred phone number. Maximum 12 characters.", Name="Phone")
public Phone?: string;
public constructor(init?: Partial<DonationDonorInfo>) { (Object as any).assign(this, init); }
}
export class DonationMemberInfo
{
// @ApiMember(IsRequired=true)
public BhUserId: number;
public constructor(init?: Partial<DonationMemberInfo>) { (Object as any).assign(this, init); }
}
export class DonationAchRequest extends DonationRequestBase implements IDonationRequestWithDonorInfo
{
/**
* Not required if MemberInfo is present on request
*/
// @ApiMember(Description="Not required if MemberInfo is present on request")
public DonorInfo?: DonationDonorInfo;
/**
* Not required if DonorInfo is present on request
*/
// @ApiMember(Description="Not required if DonorInfo is present on request")
public MemberInfo?: DonationMemberInfo;
/**
* Use GET /campaigns to retreive valid list of campaignIDs
*/
// @ApiMember(Description="Use GET /campaigns to retreive valid list of campaignIDs")
public CampaignId?: number;
/**
* RoutingNumber and AccountNumber are not required if AchRef is provided
*/
// @ApiMember(Description="RoutingNumber and AccountNumber are not required if AchRef is provided")
public AchRef?: string;
/**
* Required if AchRef is not provided
*/
// @ApiMember(Description="Required if AchRef is not provided")
public RoutingNumber?: string;
/**
* Required if AchRef is not provided
*/
// @ApiMember(Description="Required if AchRef is not provided")
public AccountNumber?: string;
public constructor(init?: Partial<DonationAchRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript DonationAchRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
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-01
},
MetaData:
{
String: "String"
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ErrorCode: 0,
ErrorMessage: String,
IsError: False,
TransactionId: String
}