Skip to content

Move timeout to refund reason #303

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

Merged
shreyav merged 1 commit into from
Mar 29, 2026
Merged

Move timeout to refund reason #303

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
2 changes: 1 addition & 1 deletion mintlify/openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion 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 @@ -271,7 +271,6 @@ Use for reconciliation and reporting.
| `QUOTE_EXPIRED` | Quote expired before execution | Create new quote |
| `QUOTE_EXECUTION_FAILED` | Error executing the quote | Create new quote |
| `INSUFFICIENT_BALANCE` | Source account lacks funds | Fund account, retry |
Comment on lines 272 to 273
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Mar 27, 2026

Choose a reason for hiding this comment

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

P2 TIMEOUT removed without documenting the new refund behavior

TIMEOUT is removed from the failure reasons table, but the page gives no hint that a timeout now results in a refund. A developer reading this page would have no documentation trail explaining what happens when a transaction times out.

Consider adding a brief note in the Failure Handling section, or a new "Refund reasons" table entry:

| `TIMEOUT` | Transaction timed out; refund issued automatically | Check refund status |

This also applies to mintlify/snippets/error-handling.mdx line 147 where the same entry was removed.

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

Comment:
**`TIMEOUT` removed without documenting the new refund behavior**

`TIMEOUT` is removed from the failure reasons table, but the page gives no hint that a timeout now results in a refund. A developer reading this page would have no documentation trail explaining what happens when a transaction times out.

Consider adding a brief note in the Failure Handling section, or a new "Refund reasons" table entry:

```mdx
| `TIMEOUT` | Transaction timed out; refund issued automatically | Check refund status |
```

This also applies to `mintlify/snippets/error-handling.mdx` line 147 where the same entry was removed.

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

| `TIMEOUT` | Transaction timed out | Retry or contact support |

## Best Practices

Expand Down
1 change: 0 additions & 1 deletion mintlify/snippets/error-handling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@ When a transaction fails, the `failureReason` field provides specific details:
- `QUOTE_EXPIRED` - Quote expired before execution
- `QUOTE_EXECUTION_FAILED` - Error executing the quote
- `FUNDING_AMOUNT_MISMATCH` - Funding amount doesn't match expected amount
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Mar 27, 2026

Choose a reason for hiding this comment

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

P2 TIMEOUT removed but not documented as refund reason

TIMEOUT is correctly removed from the outgoing failure reasons list here, but there's no corresponding mention that a TIMEOUT will now result in a refund with reason: TIMEOUT. Developers referencing this snippet after the change may not know how to handle the timeout scenario at all.

Since this snippet is shared across multiple sections, consider adding a note (or a dedicated refund-reasons bullet list) indicating that TIMEOUT scenarios now surface as a refund:

- `TIMEOUT` - Transaction timed out; funds are returned as a refund with `reason: TIMEOUT`

or in a separate refund reasons section:

### Refund reasons

- `TRANSACTION_FAILED` - Transaction failed after funds were sent
- `USER_CANCELLATION` - Payment cancelled by user
- `TIMEOUT` - Transaction timed out before completion
Prompt To Fix With AI 
This is a comment left during a code review.
Path: mintlify/snippets/error-handling.mdx
Line: 147

Comment:
**`TIMEOUT` removed but not documented as refund reason**

`TIMEOUT` is correctly removed from the outgoing failure reasons list here, but there's no corresponding mention that a `TIMEOUT` will now result in a refund with `reason: TIMEOUT`. Developers referencing this snippet after the change may not know how to handle the timeout scenario at all.

Since this snippet is shared across multiple sections, consider adding a note (or a dedicated refund-reasons bullet list) indicating that `TIMEOUT` scenarios now surface as a refund:

```mdx
- `TIMEOUT` - Transaction timed out; funds are returned as a refund with `reason: TIMEOUT`
```

or in a separate refund reasons section:

```mdx
### Refund reasons

- `TRANSACTION_FAILED` - Transaction failed after funds were sent
- `USER_CANCELLATION` - Payment cancelled by user
- `TIMEOUT` - Transaction timed out before completion
```

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

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

- `TIMEOUT` - Transaction timed out

### Incoming payment failures

Expand Down
2 changes: 1 addition & 1 deletion openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions openapi/components/schemas/common/Refund.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@ properties:
enum:
- TRANSACTION_FAILED
- USER_CANCELLATION
- TIMEOUT
description: Reason for the refund
example: TRANSACTION_FAILED
1 change: 0 additions & 1 deletion openapi/components/schemas/transactions/OutgoingTransactionFailureReason.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ enum:
- LIGHTNING_PAYMENT_FAILED
- FUNDING_AMOUNT_MISMATCH
- COUNTERPARTY_POST_TX_FAILED
- TIMEOUT
description: >-
Reason for failure of an outgoing transaction. This is used to provide more
context on why a transaction failed. If the transaction is not in a failed
Expand Down
Loading