Skip to content

docs(transactions): document the 501 response on the cancel endpoint #774

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

Draft
ls-bolt wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(transactions): document the 501 response on the cancel endpoint #774

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
8 changes: 7 additions & 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.

8 changes: 7 additions & 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.

15 changes: 14 additions & 1 deletion openapi/paths/transactions/transactions_{transactionId}_cancel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ post:
$ref: ../../components/schemas/transactions/CancelTransactionRequest.yaml
responses:
'200':
description: Cancellation requested successfully
description: >-
The banking partner accepted the cancellation request. The transfer
reaches its cancelled state once the partner confirms it, so the
transaction returned here may still report its pre-cancellation status.
content:
application/json:
schema:
Expand Down Expand Up @@ -68,3 +71,13 @@ post:
application/json:
schema:
$ref: ../../components/schemas/errors/Error500.yaml
'501':
description: >-
Not implemented for this payment rail. Cancellation depends on the
banking partner settling the transfer exposing a cancellation facility;
rails without one — wires, and ACH at partners that do not support it —
return `501 NOT_IMPLEMENTED`.
content:
application/json:
schema:
$ref: ../../components/schemas/errors/Error501.yaml
Loading