Billhighway Cloud API

<back to all web services

UserObligationSignupPostRq

The following routes are available for this service:
POST/signup/obligation
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserObligationSignupPostRs:
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserObligationSignupPostRq:
    model_state_id: Optional[int] = None
    chap_bill_cat_id: Optional[int] = None
    voluntary_bi_weekly_contribution: Optional[Decimal] = None
    other_amount: Optional[Decimal] = None
    payer_name: Optional[str] = None
    routing_number: Optional[str] = None
    ach_account_type: Optional[str] = None
    ach_account_number: Optional[str] = None
    ach_confirm_account_number: Optional[str] = None
    signature_pad: Optional[str] = None
    confirm_signature: Optional[bool] = None
    bh_user_i_d: Optional[int] = None
    client_doc_no: Optional[str] = None
    email: Optional[str] = None
    bh_chapter_id: Optional[int] = None

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