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.

import 'package:servicestack/servicestack.dart';

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

    int? ErrorCode;
    String? ErrorMessage;
    // @ApiMember(ExcludeInSchema=true)
    bool? IsError;

    String? AchReference;

    AchRefRequestReply({this.BankAccountToken,this.ErrorCode,this.ErrorMessage,this.IsError,this.AchReference});
    AchRefRequestReply.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BankAccountToken = json['BankAccountToken'];
        ErrorCode = json['ErrorCode'];
        ErrorMessage = json['ErrorMessage'];
        IsError = json['IsError'];
        AchReference = json['AchReference'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BankAccountToken': BankAccountToken,
        'ErrorCode': ErrorCode,
        'ErrorMessage': ErrorMessage,
        'IsError': IsError,
        'AchReference': AchReference
    };

    getTypeName() => "AchRefRequestReply";
    TypeContext? context = _ctx;
}

class AchRefRequest implements IConvertible
{
    int? ClientId;
    String? BankAccount;
    // @ApiMember(IsRequired=true)
    String? GroupId;

    // @ApiMember(IsRequired=true)
    String? RoutingNumber;

    // @ApiMember(IsRequired=true)
    String? AccountNumber;

    AchRefRequest({this.ClientId,this.BankAccount,this.GroupId,this.RoutingNumber,this.AccountNumber});
    AchRefRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ClientId = json['ClientId'];
        BankAccount = json['BankAccount'];
        GroupId = json['GroupId'];
        RoutingNumber = json['RoutingNumber'];
        AccountNumber = json['AccountNumber'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ClientId': ClientId,
        'BankAccount': BankAccount,
        'GroupId': GroupId,
        'RoutingNumber': RoutingNumber,
        'AccountNumber': AccountNumber
    };

    getTypeName() => "AchRefRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'AchRefRequestReply': TypeInfo(TypeOf.Class, create:() => AchRefRequestReply()),
    'AchRefRequest': TypeInfo(TypeOf.Class, create:() => AchRefRequest()),
});

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