commit b4e52efc5360b0ed4168fbf1bf9c147cb9d839b9
parent cca8fbf884e698c1bef68ba05f4df0469f1bdf2f
Author: Christian Grothoff <christian@grothoff.org>
Date: Tue, 16 Jul 2024 13:34:35 +0200
spec wire gateway protocol v1
Diffstat:
1 file changed, 25 insertions(+), 3 deletions(-)
diff --git a/core/api-bank-wire.rst b/core/api-bank-wire.rst
@@ -29,7 +29,7 @@ LibEuFin (work in progress).
.. http:get:: /config
Return the protocol version and configuration information about the bank.
- This specification corresponds to ``current`` protocol being version **0**.
+ This specification corresponds to ``current`` protocol being version **1**.
**Response:**
@@ -222,9 +222,33 @@ Querying the transaction history
// Union discriminated by the "type" field.
type IncomingBankTransaction =
+ | IncomingKycAuthTransaction
| IncomingReserveTransaction
| IncomingWadTransaction;
+ .. ts:def:: IncomingKycAuthTransaction
+
+ // Since protocol **v1**.
+ interface IncomingKycAuthTransaction {
+ type: "KYCAUTH";
+
+ // Opaque identifier of the returned record.
+ row_id: SafeUint64;
+
+ // Date of the transaction.
+ date: Timestamp;
+
+ // Amount transferred.
+ amount: Amount;
+
+ // Payto URI to identify the sender of funds.
+ debit_account: string;
+
+ // The account public key extracted from the transaction details.
+ account_pub: EddsaPublicKey;
+
+ }
+
.. ts:def:: IncomingReserveTransaction
interface IncomingReserveTransaction {
@@ -450,5 +474,3 @@ Design:
We explicitly reject any design where the user would have to enter a confirmation code
they get from their bank in the context of the wallet, as this would teach and normalize
bad security habits.
-
-