summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorMS <ms@taler.net>2022-12-19 12:58:42 +0100
committerMS <ms@taler.net>2022-12-19 12:58:42 +0100
commitf2be1a49e103c08dc7532413ce10166303cd3c3c (patch)
treeb54f7a5b79caabe37c055b2f4930d843aa83098d /libeufin
parentd25e4773adcdfd6721fbb769eef0183a5ef93888 (diff)
downloaddocs-f2be1a49e103c08dc7532413ce10166303cd3c3c.tar.gz
docs-f2be1a49e103c08dc7532413ce10166303cd3c3c.tar.bz2
docs-f2be1a49e103c08dc7532413ce10166303cd3c3c.zip
404 on status of aborted cashouts
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-sandbox.rst32
1 files changed, 14 insertions, 18 deletions
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index 9154b423..75b4bcf5 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -58,7 +58,7 @@ Accounts
// Addresses where to send the TAN. If
// this field is missing, then the cashout
// won't succeed.
- contact_data?: CircuitContactData;
+ contact_data: CircuitContactData;
// Legal subject owning the account.
name: string;
@@ -222,11 +222,7 @@ Accounts
// IBAN hosted at Libeufin Sandbox
iban: string;
- // E-Mail address
- email: string;
-
- // Phone number.
- phone: string;
+ contact_data: CircuitContactData;
// Legal subject owning the account.
name: string;
@@ -280,18 +276,16 @@ Cashouts
subject?: string;
// That is the plain amount that the user specified
- // to cashout. It has the $currency:$amount format,
- // where $currency is the circuit currency.
- amount_debit: string;
+ // to cashout. Its $currency is the circuit currency.
+ amount_debit: Amount;
// That is the amount that will effectively be
// transferred by the bank to the user's bank
// account, that is external to the circuit.
- // It has the $currency:$amount format, where
- // $currency is the fiat currency and $amount
+ // It is expressed in the fiat currency and
// is calculated after the cashout fee and the
// exchange rate. See the /cashout-rates call.
- amount_credit: string;
+ amount_credit: Amount;
// Which channel the TAN should be sent to. If
// this field is missing, it defaults to SMS.
@@ -334,8 +328,11 @@ Cashouts
:http:statuscode:`204 No content`:
``$cashoutId`` was found in the *pending* state
and got successfully aborted.
+ :http:statuscode:`404 Not found`:
+ ``$cashoutId`` is not found. Note: that happens
+ also when ``$cashoutId`` got aborted before this request.
:http:statuscode:`412 Precondition failed`:
- ``$cashoutId`` was already confirmed or aborted.
+ ``$cashoutId`` was already confirmed.
.. http:post:: /cashouts/$cashoutId/confirm
@@ -360,10 +357,13 @@ Cashouts
got successfully confirmed.
:http:statuscode:`403 Forbidden`:
wrong TAN.
+ :http:statuscode:`404 Not found`:
+ ``$cashoutId`` is not found. Note: that happens
+ also when ``$cashoutId`` got aborted before this request.
:http:statuscode:`409 Conflict`:
A institutional user (``admin`` or ``bank``) tried the operation.
:http:statuscode:`412 Precondition failed`:
- ``$cashoutId`` was already confirmed or aborted.
+ ``$cashoutId`` was already confirmed.
.. _cashout-rates:
@@ -435,10 +435,6 @@ Cashouts
// The cashout was created and now waits
// for the TAN by the author.
PENDING = "pending",
-
- // The cashout was aborted before the
- // confirmation.
- ABORTED = "aborted"
}
**Response:**