docs: document receipt delivery confirmation endpoint - #542
Conversation
Add a new section to the transaction lifecycle guide explaining the
receipt delivery confirmation endpoint (POST /transactions/{transactionId}/confirm).
This endpoint was added in commit 1de75a3 and allows platforms to record
when they delivered a receipt to their customer, which may be required
for compliance purposes.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Greptile SummaryThis PR adds a "Receipt Delivery Confirmation" section to the Transaction Lifecycle guide, documenting the
Confidence Score: 2/5Not safe to merge — the unclosed code fence will cause the entire new section to render incorrectly in published docs. The bash code block added in the new "Receipt Delivery Confirmation" section is never closed. Everything after the curl command — the explanatory prose and the Info callout — will render as raw text inside the code block, making the section unreadable as published documentation. mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx — the missing closing fence must be added before this is published.
|
| Filename | Overview |
|---|---|
| mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx | Adds "Receipt Delivery Confirmation" section, but the bash code block is missing its closing fence, causing the prose explanation and Info callout to render as raw code content instead of formatted text. |
Sequence Diagram
sequenceDiagram
participant P as Platform
participant G as Grid API
P->>G: "POST /transactions/{transactionId}/confirm"
Note right of G: Body: {"receiptDeliveryConfirmedAt": "..."}
G-->>P: 200 OK – transaction with receiptDeliveryConfirmedAt set
Note left of P: Receipt delivery timestamp recorded
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx:364-374
**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).
Reviews (2): Last reviewed commit: "Update transaction-lifecycle.mdx" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| ```bash | ||
| curl -X POST "https://api.example.com/transactions/{transactionId}/confirm" \ | ||
| -H "Content-Type: application/json" \ | ||
| -H "Authorization: Bearer YOUR_API_KEY" \ | ||
| -d '{"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> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.comwithAuthorization: Bearer YOUR_API_KEY. Grid uses the versioned base URL and BasicAuth, so it's nowhttps://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
200response body (the updated transaction withreceiptDeliveryConfirmedAtpopulated), which the earlier Greptile suggestion on this section had asked for and matchestransactions_{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.
|
📌 Bolt Status 2026-07-30 16:25:39 UTC — ⚡ Agent |
|
⚡ On it - fixing the unclosed |
Close the unclosed bash fence so the following prose and Info callout render as documentation instead of raw code, and align the curl example with the versioned api.lightspark.com base URL and BasicAuth used elsewhere in this guide. Co-Authored-By: jklein24 <jklein24@users.noreply.github.com>
Revision 3Addresses the P0 on the Receipt Delivery Confirmation section (
Verified: |
3 participants
Summary
POST /transactions/{transactionId}/confirmendpoint to the Transaction Lifecycle guideChanges
Documentation (Mintlify)
platform-overview/core-concepts/transaction-lifecycle.mdxReview Checklist
Reviewed the following areas for sync with commit 1de75a3:
🤖 Generated with Claude Code