Billhighway Cloud API

<back to all web services

DonationCreditCardRequest

The following routes are available for this service:
POST/donations/creditcard
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 DonationCreditCardRequest
        : 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>
        ///Campaign to track donation against and to define fund allocation. Use GET /campaigns to retreive valid list of campaignIDs
        ///</summary>
        [ApiMember(Description="Campaign to track donation against and to define fund allocation. Use GET /campaigns to retreive valid list of campaignIDs")]
        public virtual int? CampaignId { get; set; }

        ///<summary>
        ///CardRef returned from client-side tokenization.  Also handles raw card number if your servers are PCI-DSS-compliant, and in that case this must be a valid card number for the CardType indicated.
        ///</summary>
        [ApiMember(Description="CardRef returned from client-side tokenization.  Also handles raw card number if your servers are PCI-DSS-compliant, and in that case this must be a valid card number for the CardType indicated.", IsRequired=true, Name="CardReferenceOrCardNumber")]
        public virtual string CardReferenceOrCardNumber { get; set; }

        public virtual string CardType { get; set; }
        ///<summary>
        ///Credit Card Validation value. If Visa, Master Card or Discover, must be 3 digits. If AmEx, must be 4 digits.
        ///</summary>
        [ApiMember(Description="Credit Card Validation value. If Visa, Master Card or Discover, must be 3 digits. If AmEx, must be 4 digits.", Name="Cvv")]
        public virtual string Cvv { get; set; }

        [ApiMember(IsRequired=true)]
        [ApiMember(Description="Credit Card expiration month. Valid Values 1-12.", IsRequired=true, Name="ExpirationMonth")]
        public virtual int ExpirationMonth { get; set; }

        ///<summary>
        ///Credit Card expiration year. Four-digit Year. Value cannot be less than current year or more than 20 years in the future. ExpMonth + ExpYear must not be in the past.
        ///</summary>
        [ApiMember(Description="Credit Card expiration year. Four-digit Year. Value cannot be less than current year or more than 20 years in the future. ExpMonth + ExpYear must not be in the past.", IsRequired=true, Name="ExpirationYear")]
        public virtual int ExpirationYear { get; set; }
    }

    public partial class DonationCreditCardResponse
        : 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 virtual string CardRef { 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>
    {
    }

}

C# DonationCreditCardRequest 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/creditcard HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DonationCreditCardRequest 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>
  <CampaignId>0</CampaignId>
  <CardReferenceOrCardNumber>String</CardReferenceOrCardNumber>
  <CardType>String</CardType>
  <Cvv>String</Cvv>
  <DonorInfo>
    <Address>String</Address>
    <City>String</City>
    <EmailAddress>String</EmailAddress>
    <FullName>String</FullName>
    <Phone>String</Phone>
    <PostalCode>String</PostalCode>
    <State>String</State>
  </DonorInfo>
  <ExpirationMonth>0</ExpirationMonth>
  <ExpirationYear>0</ExpirationYear>
  <MemberInfo>
    <BhUserId>0</BhUserId>
  </MemberInfo>
</DonationCreditCardRequest>

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

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