Billhighway Cloud API

<back to all web services

StandardSignupFormPostRq

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

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO.RecurringObligation

        Public Partial Class ContributionItem
            Public Overridable Property ChartOfAccountId As Integer
            Public Overridable Property ChartOfAccountRefId As String
            Public Overridable Property Amount As Decimal
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.StandardSignupForm

        Public Partial Class StandardSignupFormMemberInfo
            Public Overridable Property BhUserID As Integer
            Public Overridable Property BhGroupID As Integer
            Public Overridable Property ClientUserID As String
            Public Overridable Property ClientGroupID As String
            Public Overridable Property NationalID As Integer
            Public Overridable Property FirstName As String
            Public Overridable Property MiddleName As String
            Public Overridable Property LastName As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property City As String
            Public Overridable Property State As String
            Public Overridable Property PostalCode As String
            Public Overridable Property Country As String
            Public Overridable Property Email As String
            Public Overridable Property Phone As String
            Public Overridable Property PacContributionAmount As String
            Public Overridable Property DateOfBirth As Nullable(Of Date)
            Public Overridable Property MemberTypeClientID As String
            Public Overridable Property BillingTypeID As String
            Public Overridable Property FiscalYear As Integer
            Public Overridable Property OptedToPayCTADues As Boolean
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Request

        Public Partial Class StandardSignupFormPostRq
            Public Sub New()
                Contributions = New List(Of ContributionItem)
            End Sub

            Public Overridable Property IsCreditCard As Boolean
            Public Overridable Property MemberInfo As StandardSignupFormMemberInfo
            Public Overridable Property VerificationInfo As ClientVerification
            Public Overridable Property CcPaymentInfo As CcPaymentInformation
            Public Overridable Property AchPaymentInfo As AchPaymentInformation
            Public Overridable Property Contributions As List(Of ContributionItem)
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Response

        Public Partial Class StandardSignupFormPostRs
            Public Overridable Property Message As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.Subscriptions

        Public Partial Class AchPaymentInformation
            Public Overridable Property AccountHolderName As String
            Public Overridable Property CheckNumber As String
            Public Overridable Property RoutingNumber As String
            Public Overridable Property AccountNumber As String
            Public Overridable Property AccountType As String
        End Class

        Public Partial Class CcPaymentInformation
            Public Overridable Property CardNumber As String
            Public Overridable Property Cvv As String
            Public Overridable Property ExpMonth As Integer
            Public Overridable Property ExpYear As Integer
            Public Overridable Property CardholderName As String
            Public Overridable Property Country As String
            Public Overridable Property BillingAddress As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property City As String
            Public Overridable Property StateProvince As String
            Public Overridable Property PostalCode As String
        End Class

        Public Partial Class ClientVerification
            Public Overridable Property Provider As String
            Public Overridable Property VerificationCode As String
        End Class
    End Namespace
End Namespace

VB.NET 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>