Member & Client Transactions
Lynx provides multiple APIs to retrieve transactions for both members and clients.
| API Function | Description |
|---|---|
| Get Contribution Limit | Returns the HSA contribution limit for a member based on tax year, coverage type, and age. |
| Get Member Transactions | Returns all transactions, both pending and completed, that are associated to a member. Note: Will be deprecated by end of year 2026. Get Member Transaction Summary, Get Member Authorization Summary, Get Member Contribution Request Summary, Get Member Transaction Detail, Get Member Authorization Detail, and Get Member Contribution Request Detail should be used in place of this API. |
| Get All Member Transactions by Client | Returns all transactions, both pending and completed, for all members that are associated to a client. |
| Get All Business Account Transactions | Returns all transactions for business accounts that are associated to a client. |
| Get Member Transaction Summary | Returns all transactions with a status of Settled, Returned, or Sent that are associated to a member. |
| Get Member Transaction Detail | Returns detailed information for a member transaction. |
| Get Member Authorization Summary | Returns all authorizations with a status of Settled, Pending, Approved, Declined, or Canceled that are associated to a member. |
| Get Member Authorization Detail | Returns detailed information for a member authorization. |
| Get Member Contribution Request Summary | Returns all member contribution requests with a status of Settled, Pending, Rejected, or Returned that are associated to a member. |
| Get Member Contribution Request Detail | Returns detailed information for a member contribution request. |
| Get Member Transaction Item Level Detail | Returns item level detail for a specific member transaction or member authorization. |
| Get All Member Authorization Summary by Client | Returns a list of authorizations in the last seven days for all members in a client. |
| Get Pending ACH Activity | Returns a list of pending ACH transactions for a specific client org account. |
You may filter transactions by a variety of query parameters, such as startDate/endDate, category, type, and status to further narrow down your result set.
Filter by category
| category | Description |
|---|---|
| CONTRIBUTION | Client contribution to a member’s account, member contribution that was pulled from an external bank account, member contribution received via ACH, or member purchase of incentive points using cash |
| DISBURSEMENT | Member distribution originated by the Submit Reimbursement Request API or member distribution request received via ACH |
| REDEMPTION | Member directed redemption of incentive points to be used to purchase vacation services |
| TRANSFER | Client business account transaction to transfer funds when a member’s VSA account is moved from one client to another |
| DEPOSIT | Transfer of funds from a member’s HSA account to their Investment brokerage account for the purpose of placing a buy order or interest paid |
| WITHDRAWAL | Transfer of funds from a member’s Investment brokerage account to their HSA account once a sell order has settled |
| CORPORATE_ACTION | Corporate actions affect all members who are enrolled in Investments and encompass a wide variety of different situations. For example, an issuer may decide to pay a dividend to all shareholders, or one company could get purchased by another and existing shareholders exchange their shares for stock in the acquirer. |
| CARD | A purchase of goods and/or services made by using a credit or debit card, or a withdrawal from an ATM. |
| ADJUSTMENT | A manual adjustment is made in situations where the correction of an amount, or a reverse of a completed transaction is needed. For example, when a provisional credit for a dispute is applied, the member account will be credited. When a provisional credit is reversed, the member account will be debited. |
| RETURN | An ACH return is an electronic transaction that is sent back to the original sender by the recipient's bank within the time frames established by Nacha rules. It occurs when the recipient’s bank cannot process the transaction, whether it’s due to insufficient funds, an invalid account number, or a closed account, non-existent or inadequate authorization, among other reasons. |
| FEE | Fees incurred for a service or transaction |
| MEMBER_FEE_REVENUE | Accumulation of all member account fees for a client; Only applicable to client business account transactions. |
| RESERVE_FUNDED | Funds are pulled from the client org’s Root Reserve Account to support transaction settlement if the Omnibus account has insufficient funds. |
Filter by status
Transaction statuses:
status | Description |
|---|---|
Settled | A settled transaction refers to a financial transaction that has been completed and processed, where the funds have cleared and transferred from the originator to the recipient. |
Returned | An ACH payment was returned by the bank, or a received ACH payment that was returned through Lynx. |
Sent | For non-card member transactions, such as contributions, reimbursements, and fees, this status indicates the transaction was processed and the current settled balance was updated; however, the status will not be updated to Settled until nightly processing. |
Authorization statuses:
status | Description |
|---|---|
Settled | Settled card swipe authorization; if a transaction is matched with an approved authorization during processing, the authorization status is updated to “Settled” and it should be ignored |
Pending | Pending transactions are transactions that have not yet settled and are considered pre-authorizations. A pre-authorization (also “pre-auth” or “authorization hold”) is a temporary hold on a customer’s credit card that typically lasts around 5 days, or until the post-authorization (or “settlement”) comes through. |
Approved | An authorization is a debit or credit card purchase for which the merchant has received approval from the bank that issued the customer’s payment card. Monetary impact is a decrease to available balance only. |
Declined | A decline is a card transaction that could not be authorized. A card could be declined for many reasons, including the following: |
Canceled | An authorization reversal is a type of payment reversal that can be performed immediately after a transaction, before settlement occurs and the funds have been withdrawn from the customer’s account. It negates an authorization by releasing the hold on funds on a customer’s card. |
Contribution Request statuses:
| status | Description |
|---|---|
| Settled | A settled transaction refers to a financial transaction that has been completed and processed, where the funds have cleared and transferred from the originator to the recipient. |
| Pending | A member contribution request where funds were requested to be pulled from an external bank account that has not yet settled. |
| Rejected | A member contribution request where funds were requested to be pulled from an external bank account but was returned by the member’s bank prior to settlement occurring. |
| Returned | A member contribution request where funds were requested to be pulled from an external bank account but was returned by the member’s bank after settlement occurred. |
Filter by type: ATM Cash Withdrawal, ClaimReimbursement, ClientOrgContribution, Credit, Debit, Dispute, Dividend, EcommerceBuy, EcommerceRefund, Forfeiture, FS Credit Adjustment, FS Purchase, FS return, Incentive, Interest, InvestmentBuy, InvestmentFee, InvestmentSell, Load Authorization, Manual, Member, MemberAccountClosed, MemberContribution, MemberDebit, MemberPurchase, MemberTransfer, MissedFunding, MonthlyMaintenanceFee, Payroll, ReceivedAchTransaction, Refund, Reimbursement, Rollover, SentAchTransaction, THBReferral, ThirdPartyServices, TRANS Fee Debit, TransferPointsToDollars
Updated 27 days ago
