commit 83d1c4f14e571ea424beaa85eac6c202f75082b7
parent c1955543af81c70ba0741f60a05cfb06a24aa871
Author: Antoine A <>
Date: Wed, 17 Jan 2024 13:19:26 +0000
Update corebank API
Diffstat:
1 file changed, 18 insertions(+), 2 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -156,7 +156,8 @@ Account Management
// Addresses where to send the TAN for protected operations.
contact_data?: ChallengeContactData;
- // 'payto' URI of a fiat bank account.
+ // 'payto' URI of a fiat bank account with a 'receiver-name' parameter.
+ // If 'receiver-name' is missing, ``name`` will be used instead.
// Payments will be sent to this bank account
// when the user wants to convert the regional currency
// back to fiat currency outside bank.
@@ -251,7 +252,8 @@ Account Management
// Addresses where to send the TAN for protected operations.
contact_data?: ChallengeContactData;
- // 'payto' URI of a fiat bank account.
+ // 'payto' URI of a fiat bank account with a 'receiver-name' parameter.
+ // If 'receiver-name' is missing, ``name`` will be used instead.
// Payments will be sent to this bank account
// when the user wants to convert the regional currency
// back to fiat currency outside bank.
@@ -688,6 +690,20 @@ Taler Withdrawals
* ``TALER_EC_BANK_CONFIRM_INCOMPLETE`` : the withdraw operation cannot be confirmed because no exchange and reserve public key selection happened before.
* ``TALER_EC_BANK_UNALLOWED_DEBIT`` : the account does not have sufficient funds.
+.. http:post:: /accounts/$USERNAME/withdrawals/$WITHDRAWAL_ID/abort
+
+ Aborts ``WITHDRAWAL_ID`` operation. Has no effect on an already aborted
+ operation.
+
+ **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.
+
.. http:get:: /withdrawals/$WITHDRAWAL_ID
Retrieve public information about ``WITHDRAWAL_ID`` withdrawal operation.