Billhighway Cloud API

AchRefRequest

The following routes are available for this service:
POST	/payments/ach/ref	Create Ref for Ach Info	Creates 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.


export class AchRefRequestReply implements IHaveErrorField
{
    /**
    * Same as AchReference, this field is deprecated
    */
    // @ApiMember(Description="Same as AchReference, this field is deprecated")
    public BankAccountToken?: string;

    public ErrorCode?: number;
    public ErrorMessage?: string;
    // @ApiMember(ExcludeInSchema=true)
    public IsError?: boolean;

    public AchReference?: string;

    public constructor(init?: Partial<AchRefRequestReply>) { (Object as any).assign(this, init); }
}

export class AchRefRequest
{
    public ClientId?: number;
    public BankAccount?: string;
    // @ApiMember(IsRequired=true)
    public GroupId?: string;

    // @ApiMember(IsRequired=true)
    public RoutingNumber?: string;

    // @ApiMember(IsRequired=true)
    public AccountNumber?: string;

    public constructor(init?: Partial<AchRefRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
}