summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Häberli <haebu@rubigen.ch>2024-03-24 21:55:33 +0100
committerJoel Häberli <haebu@rubigen.ch>2024-03-24 21:55:33 +0100
commite2e5194278d0522d0b28b74f0a1ccd92dc0f465a (patch)
treef984c1d77a34cc67e343c06798b066bbc6738b96
parent399f546e1a12b1c6bc72a495eb59c29746c04e49 (diff)
downloaddocs-e2e5194278d0522d0b28b74f0a1ccd92dc0f465a.tar.gz
docs-e2e5194278d0522d0b28b74f0a1ccd92dc0f465a.tar.bz2
docs-e2e5194278d0522d0b28b74f0a1ccd92dc0f465a.zip
spec: add request parameters
-rw-r--r--core/api-c2ec.rst29
1 files changed, 26 insertions, 3 deletions
diff --git a/core/api-c2ec.rst b/core/api-c2ec.rst
index 297f7317..88a6144a 100644
--- a/core/api-c2ec.rst
+++ b/core/api-c2ec.rst
@@ -95,7 +95,7 @@ operation (the ``WOPID``) to interact with the withdrawal operation and eventual
// Id of the terminal of the provider requesting a withdrawal by nonce.
// Assigned by the exchange.
- provider_terminal_id: SafeUint64;
+ terminal_id: SafeUint64;
}
**Response:**
@@ -111,6 +111,16 @@ operation (the ``WOPID``) to interact with the withdrawal operation and eventual
Query information about a withdrawal operation, identified by the ``WOPID``.
+ **Request:**
+
+ :query long_poll_ms:
+ *Optional.* If specified, the bank will wait up to ``long_poll_ms``
+ milliseconds for operationt state to be different from ``old_state`` before sending the HTTP
+ response. A client must never rely on this behavior, as the bank may
+ return a response immediately.
+ :query old_state:
+ *Optional.* Default to "pending".
+
**Response:**
:http:statuscode:`200 Ok`:
@@ -189,7 +199,7 @@ C2EC implements the wire gateway API in order to check for incoming transactions
let the exchange get proofs of payments. This will allow the C2EC componente to add reserves
and therefore allow the withdrawal of the money. C2EC does not entirely implement all endpoints,
because the it is not needed for the case of C2EC. The endpoints not implemented are not described
-further. They will be available but respond with 418 http error code.
+further. They will be available but respond with 400 http error code.
.. http:get:: /config
@@ -291,7 +301,20 @@ further. They will be available but respond with 418 http error code.
row_id: SafeUint64;
}
-.. http:post:: /history/incoming
+.. http:get:: /history/incoming
+
+ **Request:**
+
+ :query start: *Optional.*
+ Row identifier to explicitly set the *starting point* of the query.
+ :query delta:
+ The *delta* value that determines the range of the query.
+ :query long_poll_ms: *Optional.* If this parameter is specified and the
+ result of the query would be empty, the bank will wait up to ``long_poll_ms``
+ milliseconds for new transactions that match the query to arrive and only
+ then send the HTTP response. A client must never rely on this behavior, as
+ the bank may return a response immediately or after waiting only a fraction
+ of ``long_poll_ms``.
**Response:**