summaryrefslogtreecommitdiff
path: root/libeufin/nexus-tutorial.rst
diff options
context:
space:
mode:
authorMS <ms@taler.net>2020-10-06 15:13:45 +0200
committerMS <ms@taler.net>2020-10-06 15:13:45 +0200
commit26e8662e519e26717c06f2af870cc2c585a2f461 (patch)
tree1b2ee01cb0be48d7b2c59ae5786c70cc6ee56d86 /libeufin/nexus-tutorial.rst
parentef679017059f0a1f297e917531aad657a94609fb (diff)
downloaddocs-26e8662e519e26717c06f2af870cc2c585a2f461.tar.gz
docs-26e8662e519e26717c06f2af870cc2c585a2f461.tar.bz2
docs-26e8662e519e26717c06f2af870cc2c585a2f461.zip
making payments with nexus
Diffstat (limited to 'libeufin/nexus-tutorial.rst')
-rw-r--r--libeufin/nexus-tutorial.rst41
1 files changed, 40 insertions, 1 deletions
diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst
index 68c52306..621f9681 100644
--- a/libeufin/nexus-tutorial.rst
+++ b/libeufin/nexus-tutorial.rst
@@ -158,6 +158,10 @@ list of transactions, and making a payment.
Request history of transactions
===============================
+..
+ FIXME: explain why requesting the history
+ goes through these two-phases.
+
It is first needed to tell Nexus to download the latest news
from the bank, and then ask it again to return the results.
@@ -189,7 +193,42 @@ client can ask to actually **see** the transactions:
Make a payment
==============
-TBD.
+..
+ FIXME: explain why payments go through these two-phases.
+
+Payments pass through two phases: preparation and submission.
+
+The following command prepares a payment:
+
+.. code-block:: shell
+
+ libeufin-cli \
+ accounts \
+ prepare-payment \
+ --account-name $CUSTOM_RENAMING_FOR_ACCOUNT \
+ --credit-iban $IBAN_TO_SEND_MONEY_TO \
+ --credit-bic $BIC_TO_SEND_MONEY_TO \
+ --credit-name $LEGAL_ENTITY_RECEIVING_THE_PAYMENT \
+ --payment-amount $AMOUNT \ # NOTE THIS.
+ --payment-subject $SUBJECT \
+ --nexus-user-id $NEXUS_USER \
+ --nexus-password $NEXUS_PASSWORD \
+ $NEXUS_URL
+
+The previous command should return a value (``$UUID``) that uniquely
+identifies the prepared payment in the Nexus system. It'll be needed
+in the next step, to **send the payment instructions to the bank**:
+
+.. code-block:: shell
+
+ libeufin-cli \
+ accounts \
+ submit-payment \
+ --account-name $CUSTOM_RENAMING_FOR_ACCOUNT \
+ --payment-uuid $UUID \
+ --nexus-user-id $NEXUS_USER \
+ --nexus-password $NEXUS_PASSWORD \
+ $NEXUS_URL
Restore the backup
==================