[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: libeufin docs
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: libeufin docs |
Date: |
Tue, 19 May 2020 15:02:09 +0200 |
This is an automated email from the git hooks/post-receive script.
dold pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new 1fd8238 libeufin docs
1fd8238 is described below
commit 1fd82382d882ad68dbcbfca5e4c0b797be715326
Author: Florian Dold <address@hidden>
AuthorDate: Tue May 19 18:32:01 2020 +0530
libeufin docs
---
libeufin/api-nexus.rst | 50 ++++++++++++++++++++++----------------------------
1 file changed, 22 insertions(+), 28 deletions(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index f175c9d..a4cc9ac 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -16,7 +16,7 @@ be supported in the future.
Users Management
----------------
-.. http:get:: <nexus>/user
+.. http:get:: {nexusBase}/user
Get information about the current user (based on the authentication
information
in this request).
@@ -34,7 +34,7 @@ Users Management
superuser: boolean;
}
-.. http:post:: <nexus>/users
+.. http:post:: {nexusBase}/users
Create a new user. Only a superuser can call this API.
@@ -60,14 +60,14 @@ Users Management
}
-.. http:get:: <nexus>/users
+.. http:get:: {nexusBase}/users
Return list of users.
Bank Account Management
-----------------------
-.. http:get:: <nexus>/bank-accounts
+.. http:get:: {nexusBase}/bank-accounts
**Response:**
@@ -87,29 +87,15 @@ Bank Account Management
holder: string;
}
-.. http:post:: <nexus>/bank-accounts/prepared-payments/submit
+.. http:post::
{nexusBase}/bank-accounts/{acctid}/prepared-payments/{pmtid}/submit
Ask nexus to submit one prepare payment at the bank.
- **Request:**
-
- .. ts:def:: SubmitPayment
-
- interface SubmitPayment {
- // Unique identifier of the (previously) prepared payment
- // to submit at the bank.
- uuid: string;
-
- // Specify the bank connectionto use for the submission.
- connection?: string;
- }
-
-
:status 404 Not Found: the unique identifier **or**
the bank connection could not be found in the system
-.. http:get:: <nexus>/bank-accounts/<my-acct>/prepared-payments/$uuid
+.. http:get:: {nexus}/bank-accounts/{my-acct}/prepared-payments/{uuid}
Ask the status of payment ``$uuid``.
@@ -147,7 +133,7 @@ Bank Account Management
preparationDate: string;
}
-.. http:post:: <nexus>/bank-accounts/<my-acct>/prepared-payments
+.. http:post:: {nexusBase}/bank-accounts/{my-acct}/prepared-payments
Ask nexus to prepare instructions for a new payment.
Note that ``my-acct`` is the bank account that will be
@@ -182,7 +168,7 @@ Bank Account Management
uuid: string;
}
-.. http:post:: <nexus>/bank-accounts/collected-transactions
+.. http:post:: {nexus}/bank-accounts/{acctid}/download-transactions
Nexus will download bank transactions using the given connection.
@@ -204,7 +190,7 @@ Bank Account Management
end: string;
}
-.. http:get:: <nexus>/bank-accounts/<my-acct>/collected-transactions
+.. http:get:: <nexus>/bank-accounts/<my-acct>/transactions
Shows which transactions are stored locally at nexus.
@@ -247,7 +233,7 @@ Bank Account Management
Bank Connections
----------------
+----------------
Bank connections connect the local LibEuFin bank account
to the real bank.
@@ -306,7 +292,7 @@ to the real bank.
the requesting user.
-.. http:post:: <nexus>/bank-connections
+.. http:post:: {nexusBase}/bank-connections
List available bank connections.
@@ -317,17 +303,25 @@ EBICS-specific APIs
The following endpoints are only available for EBICS bank connections.
They are namespaced under the ``/ebics/`` sub-resource.
-.. http:post:: <nexus>/bank-connections/<connection-name>/ebics/download/<msg>
+.. http:post::
{nexusBase}/bank-connections/<connection-name>/ebics/download/{msg}
+
+ .. warning::
+
+ Use with care. Typically only necessary for testing and debugging.
-
Perform an EBICS download transaction of type ``msg``.
This request will not affect any bank account or other state
in the nexus database. It will just make a request to the bank
and return the answer.
-.. http:post:: <nexus>/bank-connections/<connection-name>/ebics/upload/<msg>
+.. http:post::
{nexusBase}/bank-connections/<connection-name>/ebics/upload/{msg}
+
+ .. warning::
+
+ Use with care. Typically only necessary for testing and debugging.
Perform an EBICS upload transaction of type ``msg``.
This request will not affect any bank account or other state
in the nexus database. It will just make a request to the bank
and return the answer.
+
--
To stop receiving notification emails like this one, please contact
address@hidden.