Skip to content

docs: sync immediatelyExecute documentation with schema clarification #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
claude wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: sync immediatelyExecute documentation with schema clarification #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions mintlify/platform-overview/core-concepts/quote-system.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<Info>
`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).
</Info>

<Warning>
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.
</Warning>
Expand Down
19 changes: 16 additions & 3 deletions mintlify/ramps/conversion-flows/fiat-crypto-conversion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -229,6 +238,10 @@ const quote = await fetch("https://api.lightspark.com/grid/2025-10-13/quotes", {
}).then((r) => r.json());
```

<Info>
`immediatelyExecute` can only be used with sources that are either internal accounts or external accounts with direct pull functionality (e.g., ACH pull).
</Info>

## Best practices

<AccordionGroup>
Expand Down