gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated: Access API.


From: gnunet
Subject: [taler-docs] branch master updated: Access API.
Date: Thu, 21 Oct 2021 09:46:38 +0200

This is an automated email from the git hooks/post-receive script.

ms pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 8e45ff2  Access API.
8e45ff2 is described below

commit 8e45ff21dd6fab404b8d1b24dbaee27fea12365a
Author: ms <ms@taler.net>
AuthorDate: Thu Oct 21 09:46:01 2021 +0200

    Access API.
    
    Documenting the new 'transaction' resource.
---
 core/api-bank-access.rst | 51 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/core/api-bank-access.rst b/core/api-bank-access.rst
index 9d9477b..a530760 100644
--- a/core/api-bank-access.rst
+++ b/core/api-bank-access.rst
@@ -137,6 +137,57 @@ name and account password, at least in the GNU Taler demo 
bank implementation.
   :http:statuscode:`422 Unprocessable Entity` (New):
      The withdraw operation cannot be confirmed because no exchange and 
reserve public key selection happened before.
 
+------------
+Transactions
+------------
+
+.. http:GET:: ${BANK_API_BASE_URL}/accounts/${account_name}/transactions
+
+   Retrieve all the transactions where the bank account with the label 
``account_name``
+   was debited or credited.
+
+   **Response**
+   
+   .. ts:def:: BankAccountTransaction
+
+     interface BankAccountTransactionsResponse {
+       transactions: BankAccountTransaction[]; 
+     }
+
+.. http:GET:: 
${BANK_API_BASE_URL}/accounts/${account_name}/transactions/${transaction_id}
+
+   **Response**
+
+   Retrieve the transaction whose identifier is ``transaction_id``,
+   in the following format:
+
+   .. ts:def:: BankAccountTransaction
+   
+     interface BankAccountTransaction {
+   
+       creditorIban: string;
+       creditorBic: string;
+       creditorName: string;
+   
+       debtorIban: string;
+       debtorBic: string;
+       debtorName: string;
+   
+       amount: number;
+       currency: string;
+       subject: string;
+   
+       date: string; // YYYY-MM-DD
+       uid: string; // transaction (unique) ID
+       direction: "DBIT" | "CRDT";
+     }
+
+
+.. http:POST:: ${BANK_API_BASE_URL}/accounts/${account_name}/transactions
+
+     Create a new transaction where the bank account with the label 
``account_name`` is **debited**.
+
+
 ----------------------
 Registration (Testing)
 ----------------------

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]