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 .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 /signup/api/standardSignup HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StandardSignupFormPostRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm.Request">
  <AchPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:AccountHolderName>String</d2p1:AccountHolderName>
    <d2p1:AccountNumber>String</d2p1:AccountNumber>
    <d2p1:AccountType>String</d2p1:AccountType>
    <d2p1:CheckNumber>String</d2p1:CheckNumber>
    <d2p1:RoutingNumber>String</d2p1:RoutingNumber>
  </AchPaymentInfo>
  <CcPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BillingAddress>String</d2p1:BillingAddress>
    <d2p1:CardNumber>String</d2p1:CardNumber>
    <d2p1:CardholderName>String</d2p1:CardholderName>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:Cvv>String</d2p1:Cvv>
    <d2p1:ExpMonth>0</d2p1:ExpMonth>
    <d2p1:ExpYear>0</d2p1:ExpYear>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:StateProvince>String</d2p1:StateProvince>
  </CcPaymentInfo>
  <Contributions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation">
    <d2p1:ContributionItem>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:ChartOfAccountId>0</d2p1:ChartOfAccountId>
      <d2p1:ChartOfAccountRefId>String</d2p1:ChartOfAccountRefId>
    </d2p1:ContributionItem>
  </Contributions>
  <IsCreditCard>false</IsCreditCard>
  <MemberInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BhGroupID>0</d2p1:BhGroupID>
    <d2p1:BhUserID>0</d2p1:BhUserID>
    <d2p1:BillingTypeID>String</d2p1:BillingTypeID>
    <d2p1:City>String</d2p1:City>
    <d2p1:ClientGroupID>String</d2p1:ClientGroupID>
    <d2p1:ClientUserID>String</d2p1:ClientUserID>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:FiscalYear>0</d2p1:FiscalYear>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:MemberTypeClientID>String</d2p1:MemberTypeClientID>
    <d2p1:MiddleName>String</d2p1:MiddleName>
    <d2p1:NationalID>0</d2p1:NationalID>
    <d2p1:OptedToPayCTADues>false</d2p1:OptedToPayCTADues>
    <d2p1:PacContributionAmount>String</d2p1:PacContributionAmount>
    <d2p1:Phone>String</d2p1:Phone>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:State>String</d2p1:State>
  </MemberInfo>
  <VerificationInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Provider>String</d2p1:Provider>
    <d2p1:VerificationCode>String</d2p1:VerificationCode>
  </VerificationInfo>
</StandardSignupFormPostRq>

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

<StandardSignupFormPostRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm.Response">
  <Message>String</Message>
</StandardSignupFormPostRs>