Billhighway Cloud API

<back to all web services

StandardSignupFormPostRq

The following routes are available for this service:
POST/signup/api/standardSignup
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.StandardSignupForm.Request;
using BH.CloudAPI.Common4.DTO.StandardSignupForm;
using BH.CloudAPI.Common4.DTO.Subscriptions;
using BH.CloudAPI.Common4.DTO.RecurringObligation;
using BH.CloudAPI.Common4.DTO.StandardSignupForm.Response;

namespace BH.CloudAPI.Common4.DTO.RecurringObligation
{
    public partial class ContributionItem
    {
        public virtual int ChartOfAccountId { get; set; }
        public virtual string ChartOfAccountRefId { get; set; }
        public virtual decimal Amount { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.StandardSignupForm
{
    public partial class StandardSignupFormMemberInfo
    {
        public virtual int BhUserID { get; set; }
        public virtual int BhGroupID { get; set; }
        public virtual string ClientUserID { get; set; }
        public virtual string ClientGroupID { get; set; }
        public virtual int NationalID { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string MiddleName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual string Country { get; set; }
        public virtual string Email { get; set; }
        public virtual string Phone { get; set; }
        public virtual string PacContributionAmount { get; set; }
        public virtual DateTime? DateOfBirth { get; set; }
        public virtual string MemberTypeClientID { get; set; }
        public virtual string BillingTypeID { get; set; }
        public virtual int FiscalYear { get; set; }
        public virtual bool OptedToPayCTADues { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Request
{
    public partial class StandardSignupFormPostRq
    {
        public StandardSignupFormPostRq()
        {
            Contributions = new List<ContributionItem>{};
        }

        public virtual bool IsCreditCard { get; set; }
        public virtual StandardSignupFormMemberInfo MemberInfo { get; set; }
        public virtual ClientVerification VerificationInfo { get; set; }
        public virtual CcPaymentInformation CcPaymentInfo { get; set; }
        public virtual AchPaymentInformation AchPaymentInfo { get; set; }
        public virtual List<ContributionItem> Contributions { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Response
{
    public partial class StandardSignupFormPostRs
    {
        public virtual string Message { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions
{
    public partial class AchPaymentInformation
    {
        public virtual string AccountHolderName { get; set; }
        public virtual string CheckNumber { get; set; }
        public virtual string RoutingNumber { get; set; }
        public virtual string AccountNumber { get; set; }
        public virtual string AccountType { get; set; }
    }

    public partial class CcPaymentInformation
    {
        public virtual string CardNumber { get; set; }
        public virtual string Cvv { get; set; }
        public virtual int ExpMonth { get; set; }
        public virtual int ExpYear { get; set; }
        public virtual string CardholderName { get; set; }
        public virtual string Country { get; set; }
        public virtual string BillingAddress { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string City { get; set; }
        public virtual string StateProvince { get; set; }
        public virtual string PostalCode { get; set; }
    }

    public partial class ClientVerification
    {
        public virtual string Provider { get; set; }
        public virtual string VerificationCode { get; set; }
    }

}

C# StandardSignupFormPostRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /signup/api/standardSignup HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IsCreditCard: False,
	MemberInfo: 
	{
		BhUserID: 0,
		BhGroupID: 0,
		ClientUserID: String,
		ClientGroupID: String,
		NationalID: 0,
		FirstName: String,
		MiddleName: String,
		LastName: String,
		Address1: String,
		Address2: String,
		City: String,
		State: String,
		PostalCode: String,
		Country: String,
		Email: String,
		Phone: String,
		PacContributionAmount: String,
		DateOfBirth: 0001-01-01,
		MemberTypeClientID: String,
		BillingTypeID: String,
		FiscalYear: 0,
		OptedToPayCTADues: False
	},
	VerificationInfo: 
	{
		Provider: String,
		VerificationCode: String
	},
	CcPaymentInfo: 
	{
		CardNumber: String,
		Cvv: String,
		ExpMonth: 0,
		ExpYear: 0,
		CardholderName: String,
		Country: String,
		BillingAddress: String,
		Address1: String,
		Address2: String,
		City: String,
		StateProvince: String,
		PostalCode: String
	},
	AchPaymentInfo: 
	{
		AccountHolderName: String,
		CheckNumber: String,
		RoutingNumber: String,
		AccountNumber: String,
		AccountType: String
	},
	Contributions: 
	[
		{
			ChartOfAccountId: 0,
			ChartOfAccountRefId: String,
			Amount: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Message: String
}