Billhighway Cloud API

<back to all web services

UserObligationSignupPostRq

The following routes are available for this service:
POST/signup/obligation
namespace BH.CloudAPI.Common4.DTO.RecurringObligation.Request

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UserObligationSignupPostRs() = 
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type UserObligationSignupPostRq() = 
        member val ModelStateId:Int32 = new Int32() with get,set
        member val ChapBillCatId:Int32 = new Int32() with get,set
        member val VoluntaryBiWeeklyContribution:Decimal = new Decimal() with get,set
        member val OtherAmount:Decimal = new Decimal() with get,set
        member val PayerName:String = null with get,set
        member val RoutingNumber:String = null with get,set
        member val AchAccountType:String = null with get,set
        member val AchAccountNumber:String = null with get,set
        member val AchConfirmAccountNumber:String = null with get,set
        member val SignaturePad:String = null with get,set
        member val ConfirmSignature:Boolean = new Boolean() with get,set
        member val BhUserID:Int32 = new Int32() with get,set
        member val ClientDocNo:String = null with get,set
        member val Email:String = null with get,set
        member val BhChapterId:Int32 = new Int32() with get,set

F# UserObligationSignupPostRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

{
	Message: String
}