-
Notifications
You must be signed in to change notification settings - Fork 7
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.
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -357,6 +357,26 @@ 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 | ||
| POST /transactions/{transactionId}/confirm | ||
|
|
||
| { | ||
| "receiptDeliveryConfirmedAt": "2025-08-15T14:31:00Z" | ||
| } | ||
| ``` | ||
|
|
||
| **Response:** Returns the updated transaction with `receiptDeliveryConfirmedAt` populated. | ||
|
|
||
| If you omit `receiptDeliveryConfirmedAt` from the request body, Grid uses the current server time. Calling this endpoint again updates the stored confirmation time. | ||
|
pengying marked this conversation as resolved.
Outdated
|
||
|
|
||
| <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
+374
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The A closing Prompt To Fix With AIThis 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. |
||
|
|
||
| ## Listing Transactions | ||
|
|
||
| Query all transactions for a customer or date range: | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.