Billhighway Cloud API

<back to all web services

AchDonation

The following routes are available for this service:
POST/v1.2/payments/ach
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO
Imports BH.CloudAPI.Common

Namespace Global

    Namespace BH.CloudAPI.Common

        <DataContract(Namespace:="www.billhighway.com/api")>
        Public Partial Class LegacyApiResponse
            Implements IHaveErrorField
            <DataMember>
            Public Overridable Property amount As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property confirmationNumber As String

            <DataMember>
            Public Overridable Property responseCode As String

            <DataMember>
            Public Overridable Property responseDescription As String

            <DataMember>
            Public Overridable Property resultCode As ResultCode
        End Class

        Public Enum ResultCode
            Success = 0
            Duplicate = -7
            NotAvailable = -6
            NotFound = -5
            GeneralError = -4
            UnexpectedError = -3
            CreditCardDeclined = -2
            DataValidationFailure = -1
        End Enum
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class AchDonation
            Inherits AchDonation
            Implements ICanBeRecurring
            Implements IReturnLegacyException
        End Class
    End Namespace
End Namespace

VB.NET AchDonation 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 /v1.2/payments/ach HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchDonation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <AccountNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</AccountNumber>
  <Amount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</Amount>
  <CheckNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CheckNumber>
  <ClientId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ClientId>
  <EmailAddress xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</EmailAddress>
  <GroupId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</GroupId>
  <Memo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Memo>
  <NumberOfOccurences xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</NumberOfOccurences>
  <Occurs xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Occurs>
  <PayerName xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</PayerName>
  <RoutingNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</RoutingNumber>
</AchDonation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LegacyApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <amount>0</amount>
  <confirmationNumber>String</confirmationNumber>
  <responseCode>String</responseCode>
  <responseDescription>String</responseDescription>
  <resultCode>Success</resultCode>
</LegacyApiResponse>