Skip to navigation

Stored instruments manifest and payments service URL in the GraphQL Storefront API

The site.storedInstrumentsManifest and site.settings.url.paymentBaseUrl fields are now documented in the GraphQL Storefront API guides. They supply the client-side pieces a storefront needs alongside the vaulting mutations, and neither requires a customer JWT.

  • storedInstrumentsManifest: returns the JavaScript bundle that renders the stored instruments UI, where a shopper manages the payment methods saved to their account. The manifest resolves per environment, so asset URLs are not hardcoded. It returns baseUrl, version, appVersion, and a scripts list, each entry carrying a src and a Subresource Integrity integrity hash. Load the scripts in the order returned and apply each integrity value to its tag.
  • paymentBaseUrl: returns the base URL of the payments service backing the storefront, for example https://payments.bigcommerce.com. Use it to build payments service requests rather than hardcoding a host, so the same storefront code works against whichever environment the store resolves to.
  • Gated per store: when stored instruments are not enabled, storedInstrumentsManifest resolves to null. Check for null and treat it as the feature being unavailable on the store rather than a transient error.

Both fields are in alpha and are marked deprecated in the schema to signal that status. Their shape may change without notice. Do not use them in production.

For details, see Get the stored instruments manifest and Get the payments service base URL in the Customers guide.