API Reference

Get payment balance information

post
https://ichra-api-staging.hioscar.com:444/ichra-api/v1/payments/get-balance

Retrieve detailed balance information for an Oscar member, including overdue balances, upcoming payments, credits, and total balance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

oscar-id of the member. Should be the full oscar id in the form OSC12345678-01

date

Optional balance-as-of date in YYYY-MM-dd format. Defaults to today's date.

string
enum

The HRA vendor administering the policy.
Optional in general: when omitted, the vendor is inferred from the authenticating client certificate. Required when submitting through a middleware/aggregator integration (a single integration that enrolls on behalf of multiple HRA vendors), where it identifies which HRA vendor administers this specific policy. Must be one of the listed values; the NONE and UNKNOWN_VENDOR sentinels are not accepted.

Responses

Updated 5 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?