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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"ModelStateId":0,"ChapBillCatId":0,"VoluntaryBiWeeklyContribution":0,"OtherAmount":0,"PayerName":"String","RoutingNumber":"String","AchAccountType":"String","AchAccountNumber":"String","AchConfirmAccountNumber":"String","SignaturePad":"String","ConfirmSignature":false,"BhUserID":0,"ClientDocNo":"String","Email":"String","BhChapterId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Message":"String"}