Skip to main content

Queries

  • hsaPaymentSettings (Experimental) — The store’s HSA/FSA payment label, buy-button toggle and eligibility widget placements, as the merchant app’s HSA/FSA settings page shows them.
  • paymentTransactions — HSA/FSA payment transactions for this store, one row per order. Filter by US Eastern calendar day and, optionally, a search string.
  • paymentTransactionsExport (Experimental) — HSA/FSA payment transactions as a CSV, the same file the merchant app exports, with shopper emails. Errors with PAYMENTS_NOT_ENABLED when payments are not enabled for this store.
  • payoutBreakdown — Per-order lines and fees for one payout. Null when payments are not enabled for this store, or when the payout id is unknown.
  • payoutReport — One payout as CSV: the same file, with the same columns, that the store’s finance team receives by email when a payout is deposited. Pass fields to choose columns for this call only; the saved selection is not changed (payoutReportSettingsUpdate changes it). Null when the payout id is unknown. Errors with PAYMENTS_NOT_ENABLED when payments are not enabled for this store.
  • payoutReportSettings (Experimental) — The store’s payout report email settings. A store that never saved them reads as off, with no recipients and the default columns. It takes the payments_settings_write scope, not payments_read, because the merchant app shows these settings (email addresses) only to users who may change checkout settings, and that is the only scope that holds an API key to that permission. Errors with PAYOUT_REPORT_EMAILS_NOT_AVAILABLE (403) when payout report emails are not available for this store.
  • payouts — HSA/FSA payouts deposited for this store. Dates filter on the payout (value) date.

Mutations

  • hsaPaymentSettingsUpdate (Experimental) — Change the store’s HSA/FSA payment settings and return them. Fields you leave out keep their values. A new label is synced to the store’s Shopify payment customization. An invalid value fails with INVALID_STOREFRONT_SETTING (400).
  • payoutReportSettingsUpdate (Experimental) — Change the store’s payout report email settings and return them. Fields you leave out keep their values. An invalid value fails with INVALID_PAYOUT_REPORT_SETTINGS (400). Errors with PAYOUT_REPORT_EMAILS_NOT_AVAILABLE (403) when payout report emails are not available for this store. Errors with PAYMENTS_NOT_ENABLED (403) when payments are not enabled for this store, and with HSA_GALE_ORGANIZATION_NOT_LINKED (409) when the store isn’t linked to its payments organization yet.

Objects

  • HsaPaymentSettings (Experimental) — How the HSA/FSA payment method appears at checkout and where its eligibility widget goes on the storefront.
  • 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.
  • PaymentTransactionsExport (Experimental) — HSA/FSA payment transactions as one CSV: the same file the merchant app’s Transactions export downloads. It holds shopper emails.
  • 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.
  • PayoutReport — One HSA/FSA payout rendered as the flat CSV the store’s finance team receives by email: one header row, one row per order line, payout columns repeated on every row.
  • PayoutReportSettings (Experimental) — Who receives the payout report by email when an HSA/FSA payout is deposited, and which columns the file carries.

Input objects

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.
  • PayoutReportField — A column of the payout report CSV. Payout columns repeat on every row; order columns differ per line.
  • PayoutStatus — Where a payout is in settlement.
  • PayoutType — Whether a payout sent funds to the merchant or reversed a previous payout.