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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientId: 0,
	BankAccount: String,
	GroupId: String,
	RoutingNumber: String,
	AccountNumber: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BankAccountToken: String,
	ErrorCode: 0,
	ErrorMessage: String,
	IsError: False,
	AchReference: String
}