diff options
| author | Joel Häberli <haebu@rubigen.ch> | 2024-04-28 23:12:34 +0200 |
|---|---|---|
| committer | Joel Häberli <haebu@rubigen.ch> | 2024-04-28 23:12:34 +0200 |
| commit | 4c37333824e6de283f9d14962fe087cb3a9b9891 (patch) | |
| tree | f3785f1471cecb29f5fa980bce2eacfaf866e331 /core | |
| parent | 8840772ac2e01af20342149b80f75a3e06c28635 (diff) | |
| download | docs-4c37333824e6de283f9d14962fe087cb3a9b9891.tar.gz docs-4c37333824e6de283f9d14962fe087cb3a9b9891.tar.bz2 docs-4c37333824e6de283f9d14962fe087cb3a9b9891.zip | |
docs: replicate abort endpoint on terminals-api
Diffstat (limited to 'core')
| -rw-r--r-- | core/api-terminal.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/core/api-terminal.rst b/core/api-terminal.rst index 5eaf4b5d..33be98a9 100644 --- a/core/api-terminal.rst +++ b/core/api-terminal.rst @@ -311,6 +311,28 @@ Config :http:statuscode:`404 Not found`: The operation was not found. +.. http:delete:: /withdrawals/$WITHDRAWAL_ID/abort + + Aborts ``WITHDRAWAL_ID`` operation. Has no effect on an already aborted + operation. This endpoint can be used by the terminal if the terminal aborts + the transaction, ensuring that the operation is also aborted at the + bank. + + **Request:** + + The request body is empty. + + **Response:** + + :http:statuscode:`204 No content`: + The withdrawal operation has been aborted. + :http:statuscode:`404 Not found`: + The withdrawal operation was not found. + :http:statuscode:`409 Conflict`: + The withdrawal operation has been confirmed previously and + can't be aborted. + + Endpoints for Integrated Sub-APIs --------------------------------- |