Billhighway Cloud API

<back to all web services

AchPaymentCollection

The following routes are available for this service:
POST/api/SalesForce/AchPaymentProcesses the ACH Payments.Validates the input values and processes the ACH Payments.
POST/payments/achProcesses the ACH Payments.Validates the input values and processes the ACH Payments.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.SalesForce

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO.SalesForce

        Public Partial Class AchPayment
            Public Sub New()
                InvoiceList = New List(Of SalesForceMemberPaymentInvoiceDetail)
            End Sub

            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property UserId As String
            Public Overridable Property BhUserId As Integer
            Public Overridable Property Amount As Decimal
            Public Overridable Property CurrencyType As String
            Public Overridable Property Country As String
            Public Overridable Property RoutingNumber As String
            Public Overridable Property AccountNumber As String
            Public Overridable Property AchReference As String
            Public Overridable Property AccountType As String
            Public Overridable Property IsSavingsAccount As Boolean
            Public Overridable Property PayerName As String
            Public Overridable Property CheckNumber As String
            Public Overridable Property PreferredEmailAddress As String
            Public Overridable Property Memo As String
            Public Overridable Property InvoiceList As List(Of SalesForceMemberPaymentInvoiceDetail)
            Public Overridable Property AutoPay As Boolean
            Public Overridable Property StoreAchInfo As Boolean
            Public Overridable Property EncryptionTypeId As Integer
        End Class

        Public Partial Class AchPaymentCollection
            Public Sub New()
                AchPaymentList = New List(Of AchPayment)
            End Sub

            Public Overridable Property AchPaymentList As List(Of AchPayment)
        End Class

        Public Partial Class AchPaymentReply
            Implements IHaveErrorField
            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property TransactionId As String
            Public Overridable Property ErrorCode As Integer
            Public Overridable Property ErrorMessage As String
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property IsError As Boolean
        End Class

        Public Partial Class AchPaymentReplyCollection
            Public Sub New()
                AchReplyCollection = New List(Of AchPaymentReply)
            End Sub

            Public Overridable Property AchReplyCollection As List(Of AchPaymentReply)
        End Class

        Public Partial Class SalesForceMemberPaymentInvoiceDetail
            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property Invoice As Integer
            Public Overridable Property AmountPaid As String
        End Class
    End Namespace
End Namespace

VB.NET AchPaymentCollection 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 /api/SalesForce/AchPayment HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchPaymentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchPaymentList>
    <AchPayment>
      <AccountNumber>String</AccountNumber>
      <AccountType>String</AccountType>
      <AchReference>String</AchReference>
      <Amount>0</Amount>
      <AutoPay>false</AutoPay>
      <BhUserId>0</BhUserId>
      <CheckNumber>String</CheckNumber>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <Country>String</Country>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <CurrencyType>String</CurrencyType>
      <EncryptionTypeId>0</EncryptionTypeId>
      <GroupId>String</GroupId>
      <InvoiceList>
        <SalesForceMemberPaymentInvoiceDetail>
          <AmountPaid>String</AmountPaid>
          <ClassName>String</ClassName>
          <ClientId>0</ClientId>
          <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
          <Invoice>0</Invoice>
          <UniqueId>String</UniqueId>
        </SalesForceMemberPaymentInvoiceDetail>
      </InvoiceList>
      <Memo>String</Memo>
      <PayerName>String</PayerName>
      <PreferredEmailAddress>String</PreferredEmailAddress>
      <RoutingNumber>String</RoutingNumber>
      <StoreAchInfo>false</StoreAchInfo>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </AchPayment>
  </AchPaymentList>
</AchPaymentCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AchPaymentReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchReplyCollection>
    <AchPaymentReply>
      <ClientId>0</ClientId>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <TransactionId>String</TransactionId>
      <UniqueId>String</UniqueId>
    </AchPaymentReply>
  </AchReplyCollection>
</AchPaymentReplyCollection>