From 63867894e9ba7108254803308bf3122fbcab2a7e Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Thu, 9 Jan 2020 23:37:12 +0100 Subject: update wire method documentation --- core/wireformats.rst | 38 +++++++++++++++----------------------- 1 file changed, 15 insertions(+), 23 deletions(-) diff --git a/core/wireformats.rst b/core/wireformats.rst index 724b069a..c6005729 100644 --- a/core/wireformats.rst +++ b/core/wireformats.rst @@ -17,30 +17,28 @@ X-TALER-BANK The "x-taler-bank" wire format is used for testing and for integration with Taler's simple "bank" system which in the future might be useful to setup a bank -for a local / regional currency or accounting system. Using the @code{x-taler-bank} +for a local / regional currency or accounting system. Using ``x-taler-bank`` wire method in combination with the Taler's bank, it is thus possible to fully test the Taler system without using "real" currencies. The URL format for "x-taler-bank" is simple, in that it only specifies an account number and the URL of the bank: - * payto://x-taler-bank/BANK_URI/ACCOUNT_NUMBER +:: -The account number given must be a positive 53-bit integer. As with + payto://x-taler-bank/BANK_URI/ACCOUNT_IDENTIFIER + +The account identifier given must be a non-empty alphanumeric ASCII string. As with any payto://-URI, additional fields may be present (after a ?), but are not required. The BANK_URI may include a port number. If none is -given, @code{https} over port 443 is assumed. If a port number is -given, @code{http} over the given port is to be used. Note that this +given, ``https`` over port 443 is assumed. If a port number is +given, ``http`` over the given port is to be used. Note that this means that you cannot run an x-taler-bank over @code{https} on a non-canonical port. -Note that a particular exchange is usually only supporting one -particular bank with the "x-taler-bank" wire format, so it is not -possible for a merchant with an account at a different bank to use -"x-taler-bank" to transfer funds across banks. After all, this is for -testing and not for real banking. - -The "x-taler-bank" method is implemented by the @code{taler_bank} plugin. - +Note that a particular exchange is usually only supporting one particular bank +with the ``x-taler-bank`` wire format, so it is not possible for a merchant with +an account at a different bank to use "x-taler-bank" to transfer funds across +banks. After all, this is for testing and not for real banking. SEPA ---- @@ -48,23 +46,17 @@ SEPA The Single Euro Payments Area (SEPA) [#sepa]_ is a regulation for electronic payments. Since its adoption in 2012, all of the banks in the Eurozone and some banks in other countries adhere to this standard for sending and receiving -payments. Note that the currency of the transfer will (currently) always be *EUR*. In -case the receiving account is in a currency other than EURO, the receiving bank +payments. Note that the currency of the transfer will (currently) always be ``EUR``. In +case the receiving account is in a currency other than ``EUR``, the receiving bank may covert the amount into that currency; currency exchange charges may be levied by the receiving bank. For the merchant to receive deposits through SEPA, the deposit request must follow the payto:// specification for SEPA: - * payto://sepa/IBAN - +:: -The implementation of the ``ebics`` plugin which is envisioned to -support the @code{sepa} method is currently incomplete. Specifically, -we need a working implementation of ``libebics`` which is a sub-project -trying to implement the EBICS [#ebics]_ standard. + payto://sepa/IBAN .. [#sepa] SEPA - Single Euro Payments Area: http://www.ecb.europa.eu/paym/sepa/html/index.en.html -.. [#ebics] EBCIS - European Banking Computer Interface Standard - http://www.ebics.org/ -- cgit v1.2.3