Skip to content

docs: document receipt delivery confirmation endpoint#542

Open
claude[bot] wants to merge 2 commits into
mainfrom
docs/sync-20260603
Open

docs: document receipt delivery confirmation endpoint#542
claude[bot] wants to merge 2 commits into
mainfrom
docs/sync-20260603

Conversation

@claude

@claude claude Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds documentation for the new POST /transactions/{transactionId}/confirm endpoint to the Transaction Lifecycle guide
  • The endpoint was introduced in 1de75a3 to allow platforms to confirm receipt delivery for compliance purposes

Changes

Documentation (Mintlify)

  • Added "Receipt Delivery Confirmation" section to platform-overview/core-concepts/transaction-lifecycle.mdx
  • Documents the endpoint, request body, and response behavior
  • Notes that this is only needed for platforms with contractual receipt confirmation requirements

Review Checklist

Reviewed the following areas for sync with commit 1de75a3:

  • OpenAPI schema examples — already have proper examples in the YAML files
  • Mintlify documentation — updated transaction lifecycle guide
  • Kotlin sample app — no changes needed (no transaction-specific routes)
  • Grid Visualizer data — no changes needed (covers payment flow, not compliance endpoints)

🤖 Generated with Claude Code

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>
@claude claude Bot requested review from pengying and shreyav June 3, 2026 09:45
@vercel

vercel Bot commented Jun 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Preview Jun 10, 2026 5:10pm

Request Review

@mintlify

mintlify Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview Jun 3, 2026, 9:48 AM

@greptile-apps

greptile-apps Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds a "Receipt Delivery Confirmation" section to the Transaction Lifecycle guide, documenting the POST /transactions/{transactionId}/confirm endpoint for platforms with contractual receipt-delivery obligations.

  • The new section includes a curl example and an <Info> callout explaining when the endpoint is required, but the bash code block is missing its closing ``` fence, which will cause the prose and the Mintlify callout component to render as raw code content in the published docs.

Confidence Score: 2/5

Not 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.

Important Files Changed

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
Loading
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

Comment thread mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx Outdated
Comment thread mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx Outdated
Comment on lines +364 to +374
```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>

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant