summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMS <ms@taler.net>2021-09-02 21:21:44 +0000
committerMS <ms@taler.net>2021-09-02 21:21:44 +0000
commit14a8cb1fc249a68c2e713c2d98011864d0b7cb46 (patch)
tree431eb836e35f621747cdd96ecabf787079f90b16
parentbc200a32fba1a8ffa8fec841db38dccd7231edbc (diff)
downloaddocs-14a8cb1fc249a68c2e713c2d98011864d0b7cb46.tar.gz
docs-14a8cb1fc249a68c2e713c2d98011864d0b7cb46.tar.bz2
docs-14a8cb1fc249a68c2e713c2d98011864d0b7cb46.zip
Nexus API.
Including the balance along the basic information of bank accounts.
-rw-r--r--libeufin/api-nexus.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 83fe5872..5f3e7a6c 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -233,6 +233,23 @@ manages payment initiations of the account and tracks the initiations of payment
ownerName: string;
}
+
+.. http:get:: {nexusBase}/bank-accounts/{my-acct}
+
+ Get basic information about the bank account named ``my-acct``.
+
+ interface BankAccountInfoWithBalance {
+ // ID number of the database row being the default bank connection
+ // of `my-acct`.
+ defaultBankConnection: number;
+ // Payto://-URI of `my-acct`.
+ accountPaytoUri: string;
+ // Balance of `my-acct` as it was downloaded from the bank
+ // along the last Camt document. A human-readable message
+ // will inform the requester, should this value not be found.
+ lastSeenBalance: string;
+ }
+
.. http:post:: {nexusBase}/bank-accounts/{acctid}/payment-initiations/{pmtid}/submit
Ask nexus to submit one prepare payment at the bank.