API Reference

Create or update payment preference

post
https://ichra-api-staging.hioscar.com:444/ichra-api/v1/payments/upsert-payment-preference

Create or update payment preferences for an Oscar member, including payment method and autopay configuration.

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

boolean
required

Whether to enable autopay

payment_token
object

Payment token to create a new payment method

string
enum
required

Who owns/manages the payment method.
Note: VENDOR owner will resolve to PERSON if the hra_vendor (as inferred from the authenticating client certificate or directly set in the request) does not have a direct integration setup with Oscar.

Allowed:
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?