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.
import Foundation
import ServiceStack

public class AchRefRequest : Codable
{
    public var clientId:Int?
    public var bankAccount:String?
    // @ApiMember(IsRequired=true)
    public var groupId:String?

    // @ApiMember(IsRequired=true)
    public var routingNumber:String?

    // @ApiMember(IsRequired=true)
    public var accountNumber:String?

    required public init(){}
}

public class AchRefRequestReply : IHaveErrorField, Codable
{
    /**
    * Same as AchReference, this field is deprecated
    */
    // @ApiMember(Description="Same as AchReference, this field is deprecated")
    public var bankAccountToken:String?

    public var errorCode:Int?
    public var errorMessage:String?
    // @ApiMember(ExcludeInSchema=true)
    public var isError:Bool?

    public var achReference:String?

    required public init(){}
}


Swift 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>