Billhighway Cloud API

<back to all web services

PaymentApplicationRequest

The following routes are available for this service:
GET/payments/paymentApplication
PaymentApplicationRequest Parameters:
NameParameterData TypeRequiredDescription
transactionIDqueryint?No
groupIDquerystringNo
userIDquerystringNo
bhUserIDqueryint?No
transactionBeginDatequeryDateTime?No
transactionEndDatequeryDateTime?No
fiscalYearqueryint?No
pagequeryint?No
PaymentApplicationResponse Parameters:
NameParameterData TypeRequiredDescription
IsErrorformboolNo
usersformList<PaymentApplicationUser>No
ErrorMessageformstringNo
pagingformPagingNo
PaymentApplicationUser Parameters:
NameParameterData TypeRequiredDescription
groupIDformstringNo
fiscalYearformintNo
userIDformstringNo
bhUserIDformintNo
autoPayStatusformstringNo
userTransactionsformList<UserTransaction>No
UserTransaction Parameters:
NameParameterData TypeRequiredDescription
transactionIDformlongNo
dateformstringNo
typeformstringNo
accountLast4formstringNo
amountformdecimalNo
unappliedformdecimalNo
unappliedFeeformdecimalNo
returnReasonformstringNo
returnDateformstringNo
refundAmountformdecimalNo
lineItemsformList<LineItem>No
transactionHistoryformList<TransactionHistory>No
LineItem Parameters:
NameParameterData TypeRequiredDescription
chartOfAccountRefIDformstringNo
chartOfAccountDescriptionformstringNo
cashAccountformstringNo
amountformdecimalNo
feeformdecimalNo
TransactionHistory Parameters:
NameParameterData TypeRequiredDescription
typeformstringNo
dateformstringNo
lineItemsformList<LineItem>No
Paging Parameters:
NameParameterData TypeRequiredDescription
pageformintNo
totalPagesformintNo
nextformstringNo

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.

GET /payments/paymentApplication HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"IsError":true,"users":[{"groupID":"String","fiscalYear":0,"userID":"String","bhUserID":0,"autoPayStatus":"String","userTransactions":[{"transactionID":0,"date":"String","type":"String","accountLast4":"String","amount":0,"unapplied":0,"unappliedFee":0,"returnReason":"String","returnDate":"String","refundAmount":0,"lineItems":[{"chartOfAccountRefID":"String","chartOfAccountDescription":"String","cashAccount":"String","amount":0,"fee":0}],"transactionHistory":[{"type":"String","date":"String","lineItems":[{"chartOfAccountRefID":"String","chartOfAccountDescription":"String","cashAccount":"String","amount":0,"fee":0}]}]}]}],"ErrorMessage":"String","paging":{"page":0,"totalPages":0,"next":"String"}}