Skip to content

docs: document receipt delivery confirmation endpoint #542

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 3 commits into
base: main
Choose a base branch
from
+27 −0
Open

docs: document receipt delivery confirmation endpoint #542

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0432056
docs: document receipt delivery confirmation endpoint
github-actions[bot] Jun 3, 2026
68764f5
Update transaction-lifecycle.mdx
pengying Jun 10, 2026
d1d5b0b
docs: close bash fence in receipt delivery confirmation section
Jul 30, 2026
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
27 changes: 27 additions & 0 deletions mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,33 @@ In the manual cancellation flow, `OUTGOING_PAYMENT.COMPLETED` fires after the re
</Tab>
</Tabs>

## Receipt Delivery Confirmation

Some platforms are contractually required to send a receipt to their customer after a transaction completes. Use the receipt confirmation endpoint to record when the receipt was delivered:

```bash
curl -X POST https://api.lightspark.com/grid/2025-10-13/transactions/Transaction:019542f5-b3e7-1d02-0000-000000000030/confirm \
-u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \
-H "Content-Type: application/json" \
-d '{"receiptDeliveryConfirmedAt": "2025-08-15T14:31:00Z"}'
```

**Response:** the updated transaction, with `receiptDeliveryConfirmedAt` populated:

```json
{
"id": "Transaction:019542f5-b3e7-1d02-0000-000000000030",
"status": "COMPLETED",
"receiptDeliveryConfirmedAt": "2025-08-15T14:31:00Z"
}
```

If you omit `receiptDeliveryConfirmedAt` from the request body, Grid uses the current server time. Calling this endpoint again updates the stored confirmation time.

<Info>
This endpoint is only necessary if your platform agreement requires receipt confirmation. Most integrations do not need this step.
</Info>
Comment on lines +364 to +385

@greptile-apps greptile-apps Bot Jun 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P0 Unclosed fenced code block breaks page rendering

The bash code block opened at line 364 is never closed with a matching ``` fence. As a result, the explanatory prose ("If you omit receiptDeliveryConfirmedAt..."), the <Info> callout, and every line up to the next ``` in the "Listing Transactions" section all render as raw text inside the code block. None of the Mintlify components or formatted text in this section will display correctly in the published docs.

A closing ``` line is needed immediately after the curl command ends (after line 368).

Prompt To Fix With AI 
This is a comment left during a code review.
Path: mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx
Line: 364-374

Comment:
**Unclosed fenced code block breaks page rendering**

The `bash` code block opened at line 364 is never closed with a matching ` ``` ` fence. As a result, the explanatory prose ("If you omit `receiptDeliveryConfirmedAt`..."), the `<Info>` callout, and every line up to the next ` ``` ` in the "Listing Transactions" section all render as raw text inside the code block. None of the Mintlify components or formatted text in this section will display correctly in the published docs.

A closing ` ``` ` line is needed immediately after the `curl` command ends (after line 368).

How can I resolve this? If you propose a fix, please make it concise.

@jklein24 jklein24 Jul 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@claude fix this.

@jklein24 jklein24 Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bolt fix this

@ls-bolt ls-bolt Bot Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch — fixed in d1d5b0b.

The bash fence is now closed right after the curl command, so the trailing prose and the <Info> callout render as documentation instead of raw code.

While in there I also corrected two things in the example itself, since it wasn't a runnable request as written:

  • Host and auth: it used https://api.example.com with Authorization: Bearer YOUR_API_KEY. Grid uses the versioned base URL and BasicAuth, so it's now https://api.lightspark.com/grid/2025-10-13/... with -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET", matching the quote and account-model guides.
  • Response block: added the 200 response body (the updated transaction with receiptDeliveryConfirmedAt populated), which the earlier Greptile suggestion on this section had asked for and matches transactions_{transactionId}_confirm.yaml.

I left the error-behavior documentation out of scope — the endpoint's 400/401/404 responses are already documented in the OpenAPI reference, and this guide's other sections don't enumerate status codes inline.

make lint-openapi passes (bundle unchanged) and all 38 code fences in the file are balanced.

🤖 gated-nexus(#1) | Feedback


## Listing Transactions

Query all transactions for a customer or date range:
Expand Down
Loading