Claims & Financial Operations

Manage claims, payments, and financial account operations. Claims & Financial Operations enables developers to manage the movement of funds and financial events across benefit accounts. It includes claim processing, payment methods, card and bank account management, investment activity, and compliance workflows such as substantiation and reclaim. Use these resources to support end-to-end financial operations - from claim adjudication and payment execution to account servicing and investment management - while ensuring compliance and accurate financial tracking.

Core Financial Services

1. Transactions API

The Transactions API provides a high-fidelity, detailed ledger of all financial activities within a consumer’s benefit plans. This service acts as the definitive audit trail for a specific plan year, capturing every movement of capital.

• Comprehensive Auditing: Track contributions, claims, payments, and adjustments with a standard historical lookback of up to three years.
• Running Balances: Optionally include a “checkbook” style view by calculating the account state after each transaction.
• Flexible Querying: Deep-dive into specific data by defining ISO 8601 date ranges or requesting recent activity feeds.
• Implementation Note: If number_of_transactions is set to 0, both start_date and end_date must be provided to execute the query.

2. Spending Accounts API

The Spending Accounts API serves as the central hub for retrieving structural and balance information for various financial benefit products, such as HSAs, FSAs, or HRAs.

• Dual-Pivot Scoping: Query data at the individual consumer_id level for member portals or at the plan_id level for broad employer reporting.
• Targeted Filtering: Isolate specific benefit cycles using the plan_year_id or filter by up to two specific account_type categories simultaneously.
• High-Volume Ready: Built-in pagination handles up to 100 items per request, ensuring performance across massive corporate benefit plans.

3. Reimbursement Methods API

Manage the “where” and “how” of fund distribution with the Reimbursement Methods API. These endpoints control the channels used to return funds to consumers, such as Direct Deposit (ACH) or physical Checks.

• Method Management: List all available reimbursement channels for a consumer or retrieve granular metadata for a single method.
• Primary Destination Logic: Identify or set the is_primary flag to designate which method receives funds for a specific plan year.
• Security & Privacy: Benefit from account masking and contextual security scoped via consumer_id and employer_id.

Integration Standards

Security & Authentication

All financial operations require specific OAuth scopes to ensure data privacy and regulatory compliance:

• read:transactions: Required for auditing historical ledgers.
• read:accounts: Required for accessing spending account details and balances.
• read:reimbursements / write:reimbursements: Required for viewing or managing payment channels.

Operational Consistency

• Identifier Standards: All system identifiers (Consumer, Plan, Account, and Reimbursement IDs) utilize UUID v4 format.
• Temporal Tracking: All timestamps are formatted according to ISO 8601 (for example, 2026-04-23T18:30:00Z).
• Pagination: Services utilize a zero-based index. The default page_size is 20, with a maximum limit of 100 items per page to maintain optimal response times.
• Troubleshooting: Use the X-Request-Id header across all requests to assist in cross-system correlation and error logging within the WEX ecosystem.

Global Error Reference