Reimbursement Methods

Overview

The Reimbursement Methods API provides a centralized way to manage how funds are returned to consumers (for example, Direct Deposit, Check). These endpoints allow developers to list all available methods for a specific consumer or retrieve the granular details of a single method.

Key Features

• Dynamic Filtering: Search by plan year, primary status, or specific method types (for example, Check vs. ACH).
• Contextual Security: Scopes requests via consumer_id and employer_id to ensure data privacy.
• Full Resource State: Access comprehensive metadata including account masking and creation timestamps.

Use Cases

• Member Dashboards: Listing all active reimbursement channels for a user.
• Selection Interfaces: Allowing a user to pick a primary payment method for a specific plan year.
• System Verification: Confirming a user’s payment details before processing a claim payout.

Scopes & Permissions

Core Concepts

The Resource Model

A ReimbursementMethod defines the “where” and “how” of a payout. Methods are usually tied to specific Plan Years.

Key Attributes

• method_type: The type of reimbursement (for example, DirectDeposit, Check).
• is_primary: A boolean flag. Only one method can be the primary destination for funds per plan year.
• Contextual IDs: Use employer_id and consumer_id to ensure you are fetching data for the correct entity.

Pagination

The list endpoint uses standard zero-based pagination.

Example Response Metadata

"pagination": {
  "page": 0,
  "page_size": 20,
  "total_items": 45,
  "total_pages": 3
}

Error Handling

Idempotency

All endpoints in this section use the GETmethod. They are idempotent and safe, meaning they do not modify server state and can be called repeatedly with the same result.