From b9655af55b37d20490625610629ec0f64e2dbf2c Mon Sep 17 00:00:00 2001 From: "claude[bot]" <41898282+claude[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 08:20:14 +0000 Subject: [PATCH] docs: sync immediatelyExecute documentation with schema clarification Update documentation to reflect the schema clarification added in f3325bf that immediatelyExecute can only be used with internal account sources or external accounts with direct pull functionality. - Add Info note in quote-system.mdx explaining source type requirements - Fix fiat-crypto-conversion.mdx example to use internal account source (was incorrectly using customerId source which is incompatible) - Add Info note in fiat-crypto-conversion.mdx about source requirements Co-Authored-By: Claude Opus 4.5 --- .../core-concepts/quote-system.mdx | 4 ++++ .../fiat-crypto-conversion.mdx | 19 ++++++++++++++++--- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/mintlify/platform-overview/core-concepts/quote-system.mdx b/mintlify/platform-overview/core-concepts/quote-system.mdx index 65fb1ad8..e341c5f7 100644 --- a/mintlify/platform-overview/core-concepts/quote-system.mdx +++ b/mintlify/platform-overview/core-concepts/quote-system.mdx @@ -298,6 +298,10 @@ curl -X POST https://api.lightspark.com/grid/2025-10-13/quotes \ - Quote is created and executed in one API call - Best for: Rewards distribution, micro-payments, time-sensitive transfers + +`immediatelyExecute` can only be used for quotes with a source that is either an internal account or has direct pull functionality (e.g., ACH pull with an external account). + + Customer doesn't see rate before execution. If you want to lock a quote and confirm fees and exchange rate details before executing the quote, set `immediatelyExecute` to `false` or omit the field. diff --git a/mintlify/ramps/conversion-flows/fiat-crypto-conversion.mdx b/mintlify/ramps/conversion-flows/fiat-crypto-conversion.mdx index f5622d60..7f79c1ec 100644 --- a/mintlify/ramps/conversion-flows/fiat-crypto-conversion.mdx +++ b/mintlify/ramps/conversion-flows/fiat-crypto-conversion.mdx @@ -210,16 +210,25 @@ app.post("/webhooks/grid", async (req, res) => { ## Immediate execution -For instant on-ramps (e.g., reward payouts), use `immediatelyExecute: true`: +For instant on-ramps (e.g., reward payouts), use `immediatelyExecute: true` with an internal account source: ```javascript const quote = await fetch("https://api.lightspark.com/grid/2025-10-13/quotes", { method: "POST", body: JSON.stringify({ - source: { customerId: "Customer:...", currency: "USD" }, + source: { + sourceType: "ACCOUNT", + accountId: "InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123", + }, destination: { + destinationType: "EXTERNAL_ACCOUNT_DETAILS", externalAccountDetails: { - /* wallet details */ + customerId: "Customer:...", + currency: "BTC", + accountInfo: { + accountType: "SPARK_WALLET", + address: "spark1...", + }, }, }, lockedCurrencySide: "RECEIVING", @@ -229,6 +238,10 @@ const quote = await fetch("https://api.lightspark.com/grid/2025-10-13/quotes", { }).then((r) => r.json()); ``` + +`immediatelyExecute` can only be used with sources that are either internal accounts or external accounts with direct pull functionality (e.g., ACH pull). + + ## Best practices