Billhighway Cloud API

<back to all web services

AchRefRequest

The following routes are available for this service:
POST/payments/ach/refCreate Ref for Ach InfoCreates a reference value for the ACH values passed in.
POST/payments/ach/token(Deprecated) Create Ref for Ach Info(Deprecated) Creates a reference value for the ACH values passed in.
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 AchRefRequest
            Public Overridable Property ClientId As Integer
            Public Overridable Property BankAccount As String
            <ApiMember(IsRequired:=true)>
            Public Overridable Property GroupId As String

            <ApiMember(IsRequired:=true)>
            Public Overridable Property RoutingNumber As String

            <ApiMember(IsRequired:=true)>
            Public Overridable Property AccountNumber As String
        End Class

        Public Partial Class AchRefRequestReply
            Implements IHaveErrorField
            '''<Summary>
            '''Same as AchReference, this field is deprecated
            '''</Summary>
            <ApiMember(Description:="Same as AchReference, this field is deprecated")>
            Public Overridable Property BankAccountToken As String

            Public Overridable Property ErrorCode As Integer
            Public Overridable Property ErrorMessage As String
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property IsError As Boolean

            Public Overridable Property AchReference As String
        End Class
    End Namespace
End Namespace

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

<AchRefRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AccountNumber>String</AccountNumber>
  <BankAccount>String</BankAccount>
  <ClientId>0</ClientId>
  <GroupId>String</GroupId>
  <RoutingNumber>String</RoutingNumber>
</AchRefRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AchRefRequestReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchReference>String</AchReference>
  <BankAccountToken>String</BankAccountToken>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <IsError>false</IsError>
</AchRefRequestReply>