HSA Payments

​

Queries

• paymentTransactions (Beta) — HSA/FSA payment transactions for this store, one row per order. Filter by US Eastern calendar day and, optionally, a search string.
• payoutBreakdown (Beta) — Per-order lines and fees for one payout. Null when payments are not enabled for this store, or when the payout id is unknown.
• payouts (Beta) — HSA/FSA payouts deposited for this store. Dates filter on the payout (value) date.

​

Objects

• PaymentMethod — A card charged for an order, one entry per payment leg.
• PaymentTransaction — One HSA/FSA order on the payments ledger: what was charged, the fees taken, any refund, and the payout that settled it.
• PaymentTransactionPayout — The payout that settled this order’s capture: its id and the banking date the funds were valued.
• Payout — An HSA/FSA payout: the amount deposited, the fees are on its breakdown, and the banking dates around it.
• PayoutBreakdown — One payout plus every order line that makes it up, and how many provider transactions sit behind those lines.
• PayoutLine — One order’s contribution to a payout. amount is this line’s share. The order amounts are the whole order’s figures and repeat on every line for that order.

​

Enums

• PaymentTransactionCartType — How an HSA/FSA checkout split the cart between eligible and regular items.
• PaymentTransactionStatus — Whether an order’s payment still stands, was partly refunded, or was fully refunded.
• PayoutLineType — How a line contributed to a payout.
• PayoutStatus — Where a payout is in settlement.
• PayoutType — Whether a payout sent funds to the merchant or reversed a previous payout.