The Payment Preferences endpoints enable ICHRA vendors to manage payment methods and billing information for their members. Through these endpoints, vendors can view existing payment instruments, add new payment methods, update or remove existing instruments, and retrieve critical payment information including account balances and upcoming payment due dates.

Get Payment Preferences

View a member's existing payment preferences.

Endpoint

POST /ichra-api/v1/payments/get-payment-preferences

See the Payment API Reference for full details.

Upsert Payment Preference

Add a new payment preference or update an existing preference.

Endpoint

POST /ichra-api/v1/payments/upsert-payment-preference

See the Payment API Reference for full details.

Get Balance

This endpoint shows a comprehensive view of a member's balance, including what's overdue and what's coming up based on the date provided.

Endpoint

POST /ichra-api/v1/payments/get-balance

See the Payment API Reference for full details.