Billhighway Cloud API

UserObligationSignupPostRq

The following routes are available for this service:
POST	/signup/obligation

import 'package:servicestack/servicestack.dart';

class UserObligationSignupPostRs implements IConvertible
{
    String? Message;

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

    fromMap(Map<String, dynamic> json) {
        Message = json['Message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Message': Message
    };

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

class UserObligationSignupPostRq implements IConvertible
{
    int? ModelStateId;
    int? ChapBillCatId;
    double? VoluntaryBiWeeklyContribution;
    double? OtherAmount;
    String? PayerName;
    String? RoutingNumber;
    String? AchAccountType;
    String? AchAccountNumber;
    String? AchConfirmAccountNumber;
    String? SignaturePad;
    bool? ConfirmSignature;
    int? BhUserID;
    String? ClientDocNo;
    String? Email;
    int? BhChapterId;

    UserObligationSignupPostRq({this.ModelStateId,this.ChapBillCatId,this.VoluntaryBiWeeklyContribution,this.OtherAmount,this.PayerName,this.RoutingNumber,this.AchAccountType,this.AchAccountNumber,this.AchConfirmAccountNumber,this.SignaturePad,this.ConfirmSignature,this.BhUserID,this.ClientDocNo,this.Email,this.BhChapterId});
    UserObligationSignupPostRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ModelStateId = json['ModelStateId'];
        ChapBillCatId = json['ChapBillCatId'];
        VoluntaryBiWeeklyContribution = JsonConverters.toDouble(json['VoluntaryBiWeeklyContribution']);
        OtherAmount = JsonConverters.toDouble(json['OtherAmount']);
        PayerName = json['PayerName'];
        RoutingNumber = json['RoutingNumber'];
        AchAccountType = json['AchAccountType'];
        AchAccountNumber = json['AchAccountNumber'];
        AchConfirmAccountNumber = json['AchConfirmAccountNumber'];
        SignaturePad = json['SignaturePad'];
        ConfirmSignature = json['ConfirmSignature'];
        BhUserID = json['BhUserID'];
        ClientDocNo = json['ClientDocNo'];
        Email = json['Email'];
        BhChapterId = json['BhChapterId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ModelStateId': ModelStateId,
        'ChapBillCatId': ChapBillCatId,
        'VoluntaryBiWeeklyContribution': VoluntaryBiWeeklyContribution,
        'OtherAmount': OtherAmount,
        'PayerName': PayerName,
        'RoutingNumber': RoutingNumber,
        'AchAccountType': AchAccountType,
        'AchAccountNumber': AchAccountNumber,
        'AchConfirmAccountNumber': AchConfirmAccountNumber,
        'SignaturePad': SignaturePad,
        'ConfirmSignature': ConfirmSignature,
        'BhUserID': BhUserID,
        'ClientDocNo': ClientDocNo,
        'Email': Email,
        'BhChapterId': BhChapterId
    };

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

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

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

<UserObligationSignupPostRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation.Request">
  <AchAccountNumber>String</AchAccountNumber>
  <AchAccountType>String</AchAccountType>
  <AchConfirmAccountNumber>String</AchConfirmAccountNumber>
  <BhChapterId>0</BhChapterId>
  <BhUserID>0</BhUserID>
  <ChapBillCatId>0</ChapBillCatId>
  <ClientDocNo>String</ClientDocNo>
  <ConfirmSignature>false</ConfirmSignature>
  <Email>String</Email>
  <ModelStateId>0</ModelStateId>
  <OtherAmount>0</OtherAmount>
  <PayerName>String</PayerName>
  <RoutingNumber>String</RoutingNumber>
  <SignaturePad>String</SignaturePad>
  <VoluntaryBiWeeklyContribution>0</VoluntaryBiWeeklyContribution>
</UserObligationSignupPostRq>

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

<UserObligationSignupPostRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation.Response">
  <Message>String</Message>
</UserObligationSignupPostRs>