Billhighway Cloud API

eCheckPaymentByGroup

import 'package:servicestack/servicestack.dart';

class ResultCode
{
    static const ResultCode Success = const ResultCode._(0);
    static const ResultCode Duplicate = const ResultCode._(-7);
    static const ResultCode NotAvailable = const ResultCode._(-6);
    static const ResultCode NotFound = const ResultCode._(-5);
    static const ResultCode GeneralError = const ResultCode._(-4);
    static const ResultCode UnexpectedError = const ResultCode._(-3);
    static const ResultCode CreditCardDeclined = const ResultCode._(-2);
    static const ResultCode DataValidationFailure = const ResultCode._(-1);

    final int _value;
    const ResultCode._(this._value);
    int get value => _value;
    static List<ResultCode> get values => const [Success,Duplicate,NotAvailable,NotFound,GeneralError,UnexpectedError,CreditCardDeclined,DataValidationFailure];
}

// @DataContract(Namespace="www.billhighway.com/api")
class LegacyApiResponse implements IHaveErrorField, IConvertible
{
    // @DataMember
    double? amount;

    // @DataMember
    String? confirmationNumber;

    // @DataMember
    String? responseCode;

    // @DataMember
    String? responseDescription;

    // @DataMember
    ResultCode? resultCode;

    LegacyApiResponse({this.amount,this.confirmationNumber,this.responseCode,this.responseDescription,this.resultCode});
    LegacyApiResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        amount = JsonConverters.toDouble(json['amount']);
        confirmationNumber = json['confirmationNumber'];
        responseCode = json['responseCode'];
        responseDescription = json['responseDescription'];
        resultCode = JsonConverters.fromJson(json['resultCode'],'ResultCode',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'amount': amount,
        'confirmationNumber': confirmationNumber,
        'responseCode': responseCode,
        'responseDescription': responseDescription,
        'resultCode': JsonConverters.toJson(resultCode,'ResultCode',context!)
    };

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

class SoapArrayList extends ArrayList implements IConvertible
{
    SoapArrayList();
    SoapArrayList.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "SoapArrayList";
    TypeContext? context = _ctx;
}

// @DataContract(Namespace="www.billhighway.com/api")
class eCheckPaymentByGroupResponse extends LegacyApiResponse implements IConvertible
{
    // @DataMember(Name="eCheckPaymentByGroupResult")
    SoapArrayList? Results;

    eCheckPaymentByGroupResponse({this.Results});
    eCheckPaymentByGroupResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Results = JsonConverters.fromJson(json['Results'],'SoapArrayList',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Results': JsonConverters.toJson(Results,'SoapArrayList',context!)
    });

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

class eCheckPaymentByGroup extends eCheckPaymentByGroup implements ICanBeRecurring, IConvertible
{
    eCheckPaymentByGroup();
    eCheckPaymentByGroup.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "eCheckPaymentByGroup";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'ResultCode': TypeInfo(TypeOf.Enum, enumValues:ResultCode.values),
    'LegacyApiResponse': TypeInfo(TypeOf.Class, create:() => LegacyApiResponse()),
    'SoapArrayList': TypeInfo(TypeOf.Class, create:() => SoapArrayList()),
    'eCheckPaymentByGroupResponse': TypeInfo(TypeOf.Class, create:() => eCheckPaymentByGroupResponse()),
    'eCheckPaymentByGroup': TypeInfo(TypeOf.Class, create:() => eCheckPaymentByGroup()),
});

Dart eCheckPaymentByGroup 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 /xml/reply/eCheckPaymentByGroup HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<eCheckPaymentByGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SOAP">
  <apiKey xmlns="www.billhighway.com/api">String</apiKey>
  <featureID xmlns="www.billhighway.com/api">0</featureID>
  <clientID xmlns="www.billhighway.com/api">0</clientID>
  <groupID xmlns="www.billhighway.com/api">0</groupID>
  <Amount xmlns="www.billhighway.com/api">0</Amount>
  <rtn xmlns="www.billhighway.com/api">String</rtn>
  <accountNumber xmlns="www.billhighway.com/api">String</accountNumber>
  <payerName xmlns="www.billhighway.com/api">String</payerName>
  <checkNumber xmlns="www.billhighway.com/api">String</checkNumber>
  <email xmlns="www.billhighway.com/api">String</email>
  <memo xmlns="www.billhighway.com/api">String</memo>
  <occurs xmlns="www.billhighway.com/api">String</occurs>
  <numberOfOccurrences xmlns="www.billhighway.com/api">String</numberOfOccurrences>
</eCheckPaymentByGroup>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<eCheckPaymentByGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <amount>0</amount>
  <confirmationNumber>String</confirmationNumber>
  <responseCode>String</responseCode>
  <responseDescription>String</responseDescription>
  <resultCode>Success</resultCode>
  <eCheckPaymentByGroupResult>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:decimal">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">String</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">String</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">0</anyType>
  </eCheckPaymentByGroupResult>
</eCheckPaymentByGroupResponse>