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 java.math.*
import java.util.*
import net.servicestack.client.*


open class AchRefRequest
{
    var ClientId:Int? = null
    var BankAccount:String? = null
    @ApiMember(IsRequired=true)
    var GroupId:String? = null

    @ApiMember(IsRequired=true)
    var RoutingNumber:String? = null

    @ApiMember(IsRequired=true)
    var AccountNumber:String? = null
}

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

    var ErrorCode:Int? = null
    var ErrorMessage:String? = null
    @ApiMember(ExcludeInSchema=true)
    var IsError:Boolean? = null

    var AchReference:String? = null
}

Kotlin AchRefRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

{"BankAccountToken":"String","ErrorCode":0,"ErrorMessage":"String","IsError":false,"AchReference":"String"}